doc: fix pytest_load_initial_conftests example referring to conftest.py#14686
Open
PranavAchar01 wants to merge 1 commit into
Open
doc: fix pytest_load_initial_conftests example referring to conftest.py#14686PranavAchar01 wants to merge 1 commit into
PranavAchar01 wants to merge 1 commit into
Conversation
The 'Dynamically adding command line options' example defines pytest_load_initial_conftests under a '# installable external plugin' comment but the following prose called it 'the above conftest.py'. This contradicts the hook reference, which states the hook is not called for conftest files. Refer to it as a plugin instead. Closes pytest-dev#4482
psf-chronographer
Bot
added
the
bot:chronographer:provided
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
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.
Closes #4482.
The "Dynamically adding command line options" example in
doc/en/example/simple.rstdefinespytest_load_initial_conftestsunder a# installable external plugincomment, but the following prose referred to it as "the above conftest.py". That contradicts the hook reference in_pytest/hookspec.py, which states:@RonnyPfannschmidt confirmed in the issue that this is "indeed a mistake". This changes the wording to "the above plugin" so the example is consistent with the hook's documented behavior (it only runs from an installable plugin, not a project
conftest.py).Docs-only change; added a
changelog/4482.doc.rstentry.This documentation fix was prepared with the assistance of Claude Code and verified against the hook reference and the issue.