Use numpydoc pre-commit validation #610
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
chuckwondo
approved these changes
Jun 10, 2025
|
@maxrjones, if you apply my change suggested for #611 and merge into this PR, the mypy check should pass. |
7 tasks
|
The failure is due to #596 and unrelated to this PR, so I will merge this despite the failure |
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.
Somewhere in #601 @TomNicholas and @chuckwondo were lamenting that the CI doesn't catch numpy docstring errors. This PR adds numpydoc validation to the pre-commit configuration.
docs/releases.rstapi.rst