docs: fix incorrect :py:class: role for method reference#657
Open
sedat4ras wants to merge 1 commit intopytest-dev:mainfrom
Open
docs: fix incorrect :py:class: role for method reference#657sedat4ras wants to merge 1 commit intopytest-dev:mainfrom
sedat4ras wants to merge 1 commit intopytest-dev:mainfrom
Conversation
Closes pytest-dev#186 PluginManager.add_hookcall_monitoring() is a method, not a class. Replace the incorrect :py:class: role with :py:meth: so that Sphinx generates the correct cross-reference link.
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.
Fixes #186
PluginManager.add_hookcall_monitoring()is a method, not a class. The docs used:py:class:which generates a broken cross-reference link. Changed to:py:meth:so Sphinx correctly links to the method documentation.Before:
After: