New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Validate numpydoc docstrings #636

Open

padix-key opened this issue Aug 19, 2024 · 0 comments

Labels

enhancement good first issue

Member

padix-key commented Aug 19, 2024 •

edited

Loading

numpydoc now comes with a command line utility that validates docstrings: https://numpydoc.readthedocs.io/en/latest/validation.html
This can be used by us to ensure correct docstrings.

Add CI step for numpydoc validate
- Ensure only relevant rules are enabled
Refactor docstrings to make them compliant

The text was updated successfully, but these errors were encountered:

padix-key added enhancement good first issue labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment