Add target to validate docstrings with numpydoc #86
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
Add rules for validating docstrings using `numpydoc` to `pyproject.toml`.
Add new target to the Makefile to validate docstrings using numpydoc.
This allows to use the `numpydoc lint` command instead of launching a Python module from the terminal.
Member
|
This is great! |
Add missing comments to the objects listed in See Also in the magnetic functions for prisms, and fix the order of the sections (See Also, Notes, References).
This was referenced Dec 10, 2024
leouieda
requested changes
Jun 4, 2025
Member
leouieda
left a comment
leouieda
left a comment
There was a problem hiding this comment.
Hey Santi, this is great! A few suggestions:
- Need to bump the min numpydoc version in
env/requirements-docs.txtas well. - I'd add this as a
check-docstringsrule to theMakefileand then add it tocheckorcheck-styleso it's more complete. - I'd avoid creating a new job in the CI just for this. It could go into the
check-stylejob.
leouieda
reviewed
Jun 5, 2025
Co-authored-by: Leonardo Uieda <[email protected]>
leouieda
reviewed
Jun 5, 2025
Co-authored-by: Leonardo Uieda <[email protected]>
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.
Add new target to the Makefile to validate docstrings using
numpydoc. Add rules for validating docstrings usingnumpydoctopyproject.toml. Runmake numpydocin GitHub Actions. Fix some of the errors thatnumpydocraised: add description to functions listed in "See also" sections; sort "See also", "Notes" and "References" sections in the right order; add missing docstring to modules; add missing description of parameters and returns to private functions.