Add numpydoc pre-commit checks #25
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
Previously, numpydoc validation checks were running while building the docs. It seems more intuitive to run them alongside the other linters now that numpydoc support pre-commit, and results in better/faster feedback. In addition, this allows us to easily pin the numpydoc version and automatically update it via pre-commit.ci. It looks like the latest release of https://github.com/numpy/numpydoc doesn't yet have a `pre-commit-hooks.yaml` file, so for now we are pinned to the most recent commit.
Codecov Report
@@ Coverage Diff @@
## main #25 +/- ##
=======================================
Coverage 97.55% 97.55%
=======================================
Files 8 8
Lines 696 696
=======================================
Hits 679 679
Misses 17 17
|
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.
Previously, numpydoc validation checks were run while building the docs via Sphinx.
It seems more intuitive to run them alongside the other linters now that numpydoc supports pre-commit, and results in faster feedback with better error messages. In addition, this allows us to easily pin the numpydoc version and automatically update it via
pre-commit.ci.It looks like the latest release of https://github.com/numpy/numpydoc doesn't yet have a
pre-commit-hooks.yamlfile, so for now we are pinned to the most recent commit.