-
-
Notifications
You must be signed in to change notification settings - Fork 18.3k
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
CI/DOC: Enforce ES01 in CI #57359
CI/DOC: Enforce ES01 in CI #57359
Conversation
pre-commit.ci autofix |
@mroeschke the merge conflicts in code_checks have been resolved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just of warning, more maintainers may decide some of these numpydoc rules are not worth enforcing, but for now OK to include
Thanks @jordan-d-murphy |
okay - thanks for the heads up. Always happy to adjust and redirect effort elsewhere as needed. I certainly appreciate the speedy reviews and helpful suggestions! |
In the end it's open source and any contribution of yours is welcome :) Personally I find fixing the docs to enforce these rules is a bit more externally useful than enforcing some of the missing rules in the CI (since pandas doesn't not add new APIs with docs often anymore) |
* Enforce ES01 in CI * added pandas.Index.to_numpy
Enforce ES01 in CI so that it can be fixed and enforced in chunks like other docstring errors.
The added functions come from the result of running
scripts/validate_docstrings.py --format=actions --errors=ES01
Part of our ongoing work to continue enforcing numpydoc validations: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.