Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove quotes from example tmp_path_retention_policy #12679

Merged

Conversation

RFCArrow
Copy link

@RFCArrow RFCArrow commented Aug 1, 2024

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.

closes #12678

@RFCArrow RFCArrow force-pushed the tmp_path_retention_policy-example branch from 4939355 to f062d09 Compare August 1, 2024 15:30
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.
@RFCArrow RFCArrow force-pushed the tmp_path_retention_policy-example branch from 6c8e572 to c6c7ade Compare August 1, 2024 16:12
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided (automation) changelog entry is part of PR label Aug 1, 2024
Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@nicoddemus nicoddemus added the backport 8.3.x apply to PRs at any point; backports the changes to the 8.3.x branch label Aug 3, 2024
@nicoddemus nicoddemus merged commit dc756f4 into pytest-dev:main Aug 3, 2024
29 checks passed
Copy link

patchback bot commented Aug 3, 2024

Backport to 8.3.x: 💚 backport PR created

✅ Backport PR branch: patchback/backports/8.3.x/dc756f4117f7cbabbe0866bab1fe562ac287cc03/pr-12679

Backported as #12683

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Aug 3, 2024
…mple

Remove quotes from example tmp_path_retention_policy

(cherry picked from commit dc756f4)
nicoddemus added a commit that referenced this pull request Aug 3, 2024
…mple (#12683)

Remove quotes from example tmp_path_retention_policy

(cherry picked from commit dc756f4)

Co-authored-by: Bruno Oliveira <[email protected]>
@RFCArrow RFCArrow deleted the tmp_path_retention_policy-example branch August 6, 2024 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 8.3.x apply to PRs at any point; backports the changes to the 8.3.x branch bot:chronographer:provided (automation) changelog entry is part of PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Erroneous quotes in tmp_path_retention_policy example in docs
2 participants