From 1f120568046441e9a8e50a1979396005cc045050 Mon Sep 17 00:00:00 2001 From: Faisal Fawad Date: Wed, 10 Jan 2024 22:35:46 -0500 Subject: [PATCH] Updated tmp_path documentation [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- changelog/11790.doc.rst | 2 ++ doc/en/how-to/tmp_path.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelog/11790.doc.rst diff --git a/changelog/11790.doc.rst b/changelog/11790.doc.rst new file mode 100644 index 000000000..3dd749f27 --- /dev/null +++ b/changelog/11790.doc.rst @@ -0,0 +1,2 @@ +Changed phrasing on the ``tmp_path`` documentation to more clearly +illustrate it's behavior ("test invocation" to "current test"). diff --git a/doc/en/how-to/tmp_path.rst b/doc/en/how-to/tmp_path.rst index b75fb5964..3e680dcac 100644 --- a/doc/en/how-to/tmp_path.rst +++ b/doc/en/how-to/tmp_path.rst @@ -9,7 +9,7 @@ The ``tmp_path`` fixture ------------------------ You can use the ``tmp_path`` fixture which will -provide a temporary directory unique to the test invocation, +provide a temporary directory unique to the current test, created in the `base temporary directory`_. ``tmp_path`` is a :class:`pathlib.Path` object. Here is an example test usage: