doc: fix removed pytest.config reference in historical-notes#14216
Open
cluster2600 wants to merge 2 commits intopytest-dev:mainfrom
Open
doc: fix removed pytest.config reference in historical-notes#14216cluster2600 wants to merge 2 commits intopytest-dev:mainfrom
cluster2600 wants to merge 2 commits intopytest-dev:mainfrom
Conversation
pytest.config was removed in pytest 5.0, but the documentation on 'Conditions as strings instead of booleans' still showed it as the modern equivalent of string-based skipif conditions. Replace the broken example with the current recommended approach using request.config (via an autouse fixture), and add a note pointing to the removal notice in the deprecations page. Fixes pytest-dev#12377
for more information, see https://pre-commit.ci
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The documentation on "Conditions as strings instead of booleans" in
historical-notes.rstshowedpytest.config.getvalue()as the "modern equivalent" of string-basedskipifconditions. However,pytest.configwas removed in pytest 5.0 (see deprecations page).This led readers to believe they could use
pytest.configas a current approach when in fact it no longer exists.Changes
pytest.config.getvalue()code example with a working modern equivalent usingrequest.config.getoption()in anautousefixture.pytest.configwas removed in pytest 5.0 and linking to the deprecations page.request.config.getoption()instead of the removed API.Fixes #12377