DOC Fix incorrect heading underline length in docstrings #22278
Merged
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
numpydoc 1.2 raises a UserWarning during docstring parsing when the heading underline lengths do not match the length of the heading. This PR will prevent these warnings from being emitted during the docs build process when numpydoc 1.2 is released.
thomasjpfan
reviewed
Jan 24, 2022
There was a problem hiding this comment.
Thanks for the PR @rossbar !
Now that the sections have the correct headings, it looks like there are numpy doc validation errors in the CI. All the errors are related to section ordering:
- GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, Examples
May you address those errors for the docstrings you fixed?
rossbar
force-pushed
the
doc/fix-heading-underline-length
branch
from
4a219f8
to
4088856
Compare
On this topic - one of the new features of |
thomasjpfan
changed the title
thomasjpfan
changed the title
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.
numpydoc 1.2 (currently in rc1) raises a UserWarning during docstring parsing when the heading underline lengths do not match the length of the heading. This PR will prevent these warnings from being emitted during the docs build process when numpydoc 1.2 is released.