Add some numpydoc validation checks #2316
Merged
Conversation
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
dstansby
force-pushed
the
numpydoc-valid
branch
from
0d7a560 to
2fed6c3
Compare
d-v-b
approved these changes
Oct 9, 2024
jhamman
approved these changes
Oct 9, 2024
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.
I started reviewing one of the docstring pull requests, and found it quite tricky to review large PRs where the contents have to be consistent with function/class signatures.
This PR implements some numpydoc validation checks to give some more consistent validation fo docstrings. To keep this PR simple I've only included a few error codes and fixes, but I'm happy to roll this out to other error codes if folks are pro adding this validation.