See Also Parser Recognizes Sphinx XREF #558
Open
Conversation
This file contains 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
The See Also section raises a ValueError when it encounters a valid sphinx cross-reference such as :meth:`QImage.save <QImage.save>` This commit allows the regex to parse the sphinx target, which is the section between the angled brackets.
j9ac9k
added a commit
to j9ac9k/pyqtgraph
that referenced
this pull request
May 25, 2024
To run numpydoc lint, currently a fork of numpydoc is required, due to an unhandled exception when using sphinx cross-links in the `See Also` section. See: numpy/numpydoc#558 As still experimental, numpydoc linting/validation is not checked or required for future contributions.
j9ac9k
added a commit
to j9ac9k/pyqtgraph
that referenced
this pull request
May 25, 2024
To run numpydoc lint, currently a fork of numpydoc is required, due to an unhandled exception when using sphinx cross-links in the `See Also` section. See: numpy/numpydoc#558 As still experimental, numpydoc linting/validation is not checked or required for future contributions.
j9ac9k
added a commit
to j9ac9k/pyqtgraph
that referenced
this pull request
May 25, 2024
To run numpydoc lint, currently a fork of numpydoc is required, due to an unhandled exception when using sphinx cross-links in the `See Also` section. See: numpy/numpydoc#558 As still experimental, numpydoc linting/validation is not checked or required for future contributions.
|
We should probably allow this, but it would need a test to prevent future regression. |
Happy to add tests, I didn't notice if there was an existing test I should add or, or just roll my own thing, which I can do too, but would likely need some guidance on where it should go. |
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.
The See Also section raises a ValueError when it encounters a valid sphinx cross-reference such as
This commit allows the regex to parse the sphinx target, which is the section between the angled brackets.
Author Note: This is my first contribution to a repo such as this, so I likely missed something, comments/nit-picks welcome.