You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
example command:scripts/validate_docstrings.py --format=actions pandas.Categorical.__array__ example output:
################################################################################
################################## Validation ##################################
################################################################################
2 Errors found for `pandas.Categorical.__array__`:
ES01 No extended summary found
SA01 See Also section not found
check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported. Note: We've chosen to ignore ES01 errors, these are not required to be fixed.
remove those methods from code_checks.sh if all errors are cleared and the docstring is correct, otherwise, remove the specific error that was fixed from the list of errors for that method.
commit, push, open pull request
Please don't comment take as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work : )
DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063
Pandas has a script for validating docstrings in code_checks.sh. Currently, some methods fail some of these checks.
pandas.Categorical
pandas/ci/code_checks.sh
Lines 73 to 81 in c468028
The task is:
take 1-5 methods
run:
scripts/validate_docstrings.py --format=actions <method-name>
example command:
scripts/validate_docstrings.py --format=actions pandas.Categorical.__array__
example output:
check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported. Note: We've chosen to ignore ES01 errors, these are not required to be fixed.
remove those methods from code_checks.sh if all errors are cleared and the docstring is correct, otherwise, remove the specific error that was fixed from the list of errors for that method.
commit, push, open pull request
Please don't comment
take
as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work : )If you're new contributor, please check the contributing guide
thanks @datapythonista for the inspiration for this issue!
The text was updated successfully, but these errors were encountered: