Skip to content

Commit cfcadf3

Browse files
committed
Clarify retention policy
Document that `failed`` removes the files of passing tests in the teardown step but `none` only removes the files of tests at the end of the test session.
1 parent d49c94b commit cfcadf3

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

doc/en/reference/reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,8 +2493,8 @@ passed multiple times. The expected format is ``name=value``. For example::
24932493
based on test outcome.
24942494

24952495
* `all`: retains directories for all tests, regardless of the outcome.
2496-
* `failed`: retains directories only for tests with outcome `error` or `failed`.
2497-
* `none`: directories are always removed after each test ends, regardless of the outcome.
2496+
* `failed`: retains directories only for tests with outcome `error` or `failed`. Non-retained directories are removed during teardown of the tmp_path fixture.
2497+
* `none`: directories are always removed after each test session ends, regardless of the outcome.
24982498

24992499
.. tab:: toml
25002500

0 commit comments

Comments
 (0)