Skip to content
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.

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

DOCS: Adopt the numpydoc validation rules #5780

Open
7 tasks
tkknight opened this issue Feb 23, 2024 · 0 comments
Open
7 tasks

DOCS: Adopt the numpydoc validation rules #5780

tkknight opened this issue Feb 23, 2024 · 0 comments

Comments

@tkknight
Copy link
Contributor

tkknight commented Feb 23, 2024

📚 Documentation

The pre-commit hook to check these rules was added in #5762.

The outstanding rules review and ideally adoption are below as defined in pyproject.toml (section [tool.numpydoc_validation]). There is an option to keep them ignored only it absolutely needed.

  • GL08 The object does not have a docstring : 1320 errors
  • PR01 Parameters ... not documented : 951 errors
  • PR02 Unknown parameters {....} - 74 errors
  • PR04 Parameter "...." has no type : 407 errors
  • PR07 Parameter "...." has no description : 47 errors
  • RT01 No Returns section found : 609 errors
  • RT03 Return value has no description : 219 errors

To test these rules just comment out one at a time and then run the pre-commit locally via pre-commit run --all-files.

For more information see https://numpydoc.readthedocs.io/en/latest/validation.html.

See also #5625 ruff: incremental adoption.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant