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

Address disabled numpydocs-validation checks #569

Open
3 tasks
pp-mo opened this issue Nov 19, 2024 · 0 comments
Open
3 tasks

Address disabled numpydocs-validation checks #569

pp-mo opened this issue Nov 19, 2024 · 0 comments

Comments

@pp-mo
Copy link
Member

pp-mo commented Nov 19, 2024

QA checks which we expect later to review + possibly remove.

The ultimate goal might be to have no 'ignores',
but we think that will probably be impractical in this case.

The controls are in the pyproject.toml "[tool.numpydoc_validation]" section e.g. these lines (as-after #568)

So-far chosen permanently disables :

  • excluded specific dunder methods __eq__ / __ne__ / __repr__ (here)
  • GL01 Permit summary line on same line as docstring opening quotes.
  • GL02 Permit a blank line before docstring closing quotes.
  • GL03 Allow double blank lines,
  • SA01 Not all docstrings require a "See Also" section.
  • ES01 Not all docstrings require an "Extended Summary" section.
  • EX01 Not all docstrings require an "Examples" section.
  • YD01 Not all docstrings require a "Yields" section.

Remaining temporarily disabled checks (number of errors triggered) :

  • GL08 (*975) The object does not have a docstring
  • PR01 (*149) Parameters ... not documented
  • RT01 (*9) No Returns section found
@pp-mo pp-mo changed the title TODOs for numpydocs-validation More fixes for numpydocs-validation checks Nov 20, 2024
@pp-mo pp-mo changed the title More fixes for numpydocs-validation checks Address disabled numpydocs-validation checks Nov 22, 2024
@pp-mo pp-mo mentioned this issue Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant