Validate docstring error code #57767
Merged
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
tqa236
force-pushed
the
validate-docstring-error-codes
branch
from
ef59fd5 to
24d3592
Compare
mroeschke
reviewed
Mar 7, 2024
scripts/validate_docstrings.py
Outdated
| @@ -56,7 +57,7 @@ | |||
| ERROR_MSGS = { | |||
| "GL04": "Private classes ({mentioned_private_classes}) should not be " | |||
| "mentioned in public docstrings", | |||
| "GL05": "Use 'array-like' rather than 'array_like' in docstrings.", | |||
| "GL11": "Use 'array-like' rather than 'array_like' in docstrings.", | |||
There was a problem hiding this comment.
Could we rename this to a whole differnt prefix? like PD01?
mroeschke
reviewed
Mar 7, 2024
mroeschke
approved these changes
Mar 7, 2024
|
Thanks @tqa236 |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
* Validate docstring error code * Rename error code * Fix tests
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.
This PR does 2 things
pandaserror codes are not overlapped withnumpydoc'sI wonder if this is a welcome change? Currently, I can detect 1 duplicated error code.