Skip to content

Commit c6c7ade

Browse files
author
Rob Arrow
committed
Remove quotes from example tmp_path_retention_policy
Previously the docs contained an example for `tmp_path_retention_policy` which included quotes around the value. If the configuration was actually set with this value. The following error would be encountered `INTERNALERROR> ValueError: tmp_path_retention_policy must be either all, failed, none. Current input: "all".` This is because the value of the field was not being unwrapped from the quotes when parsed. This commit removes the quotes from the example so that if used in the configuration file, no error will occur.
1 parent f0a0436 commit c6c7ade

File tree

3 files changed

+3
-1
lines changed

3 files changed

+3
-1
lines changed

AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -351,6 +351,7 @@ Rafal Semik
351351
Raquel Alegre
352352
Ravi Chandra
353353
Reagan Lee
354+
Rob Arrow
354355
Robert Holt
355356
Roberto Aldera
356357
Roberto Polli

changelog/12678.doc.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove erroneous quotes from `tmp_path_retention_policy` example in docs.

doc/en/reference/reference.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1873,7 +1873,7 @@ passed multiple times. The expected format is ``name=value``. For example::
18731873
.. code-block:: ini
18741874
18751875
[pytest]
1876-
tmp_path_retention_policy = "all"
1876+
tmp_path_retention_policy = all
18771877
18781878
Default: ``all``
18791879

0 commit comments

Comments
 (0)