CI/DOC: Enforce SA05 in CI #57352
Merged
CI/DOC: Enforce SA05 in CI #57352
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
pre-commit.ci autofix |
mroeschke
approved these changes
Feb 12, 2024
|
Thanks @jordan-d-murphy |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
* Enforce SA05 in CI * sorted SA05 functions in code_checks.sh
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Enforce SA05 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=SA05Part 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.rstfile if fixing a bug or adding a new feature.