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

CI/DOC: Enforce ES01 in CI #57359

Merged
merged 4 commits into from
Feb 15, 2024
Merged

Conversation

jordan-d-murphy
Copy link
Contributor

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

@jordan-d-murphy
Copy link
Contributor Author

pre-commit.ci autofix

@jordan-d-murphy
Copy link
Contributor Author

@mroeschke the merge conflicts in code_checks have been resolved

Copy link
Member

@mroeschke mroeschke left a 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

@mroeschke mroeschke added this to the 3.0 milestone Feb 15, 2024
@mroeschke mroeschke merged commit 1ca9b58 into pandas-dev:main Feb 15, 2024
47 checks passed
@mroeschke
Copy link
Member

Thanks @jordan-d-murphy

@jordan-d-murphy
Copy link
Contributor Author

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!

@jordan-d-murphy jordan-d-murphy deleted the enforce_ES01 branch February 15, 2024 19:53
@mroeschke
Copy link
Member

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)

pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this pull request May 7, 2024
* Enforce ES01 in CI

* added pandas.Index.to_numpy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants