From 388691a2051f61563d2c6eabce55576fdf509376 Mon Sep 17 00:00:00 2001 From: Thomas Grainger Date: Wed, 14 Jul 2021 16:53:27 +0100 Subject: [PATCH] rename tmpdir.rst to tmp_path.rst (#8905) --- changelog/8897.doc.rst | 0 doc/en/contents.rst | 2 +- doc/en/getting-started.rst | 2 +- doc/en/how-to/index.rst | 2 +- doc/en/how-to/{tmpdir.rst => tmp_path.rst} | 5 +++-- doc/en/reference/reference.rst | 2 +- 6 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 changelog/8897.doc.rst rename doc/en/how-to/{tmpdir.rst => tmp_path.rst} (99%) diff --git a/changelog/8897.doc.rst b/changelog/8897.doc.rst new file mode 100644 index 000000000..e69de29bb diff --git a/doc/en/contents.rst b/doc/en/contents.rst index 4623d6818..b5dd35ff2 100644 --- a/doc/en/contents.rst +++ b/doc/en/contents.rst @@ -28,7 +28,7 @@ How-to guides how-to/fixtures how-to/mark how-to/parametrize - how-to/tmpdir + how-to/tmp_path how-to/monkeypatch how-to/doctest how-to/cache diff --git a/doc/en/getting-started.rst b/doc/en/getting-started.rst index 49c17734e..bbe2a680e 100644 --- a/doc/en/getting-started.rst +++ b/doc/en/getting-started.rst @@ -235,7 +235,7 @@ List the name ``tmp_path`` in the test function signature and ``pytest`` will lo FAILED test_tmp_path.py::test_needsfiles - assert 0 1 failed in 0.12s -More info on temporary directory handling is available at :ref:`Temporary directories and files `. +More info on temporary directory handling is available at :ref:`Temporary directories and files `. Find out what kind of builtin :ref:`pytest fixtures ` exist with the command: diff --git a/doc/en/how-to/index.rst b/doc/en/how-to/index.rst index cfbf50fd4..6f52aaecd 100644 --- a/doc/en/how-to/index.rst +++ b/doc/en/how-to/index.rst @@ -16,7 +16,7 @@ Core pytest functionality fixtures mark parametrize - tmpdir + tmp_path monkeypatch doctest cache diff --git a/doc/en/how-to/tmpdir.rst b/doc/en/how-to/tmp_path.rst similarity index 99% rename from doc/en/how-to/tmpdir.rst rename to doc/en/how-to/tmp_path.rst index 1823c8a4e..740cd2e36 100644 --- a/doc/en/how-to/tmpdir.rst +++ b/doc/en/how-to/tmp_path.rst @@ -1,6 +1,6 @@ -.. _`tmpdir handling`: -.. _tmpdir: +.. _`tmp_path handling`: +.. _tmp_path: How to use temporary directories and files in tests =================================================== @@ -98,6 +98,7 @@ to save time: See :ref:`tmp_path_factory API ` for details. .. _`tmpdir and tmpdir_factory`: +.. _tmpdir: The ``tmpdir`` and ``tmpdir_factory`` fixtures --------------------------------------------------- diff --git a/doc/en/reference/reference.rst b/doc/en/reference/reference.rst index 715e4350b..85a565b9b 100644 --- a/doc/en/reference/reference.rst +++ b/doc/en/reference/reference.rst @@ -607,7 +607,7 @@ Each recorded warning is an instance of :class:`warnings.WarningMessage`. tmp_path ~~~~~~~~ -:ref:`tmpdir` +:ref:`tmp_path` .. autofunction:: _pytest.tmpdir.tmp_path() :no-auto-options: