-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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
DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063
Comments
@datapythonista can you take a look over this? We had discussed this a week or so ago after the refactoring in code_checks.sh ( #57879 & #57908 ) so I wanted to make sure it's in line with what you were thinking. if it looks good to you, I'll go ahead and create issues for the rest of the method categories. Also, I did try to add labels to the child issues, but It doesn't seem to let me for some reason. |
People can exclude it, instead checking with: |
Ah gotcha thanks @ThomasBur |
@ThomasBur I updated the example above, can you confirm it looks correct? |
Looks good, but you'll need to start the command with |
I think |
@jordan-d-murphy Mr murphy can you please add #58498 to the body of the parent issue? |
Pandas has a script for validating docstrings:
pandas/ci/code_checks.sh
Lines 68 to 1266 in c468028
Currently, some methods fail some of these checks.
The work will be broken up into several tickets, to address the work in issues of a more manageable size.
Issues:
DOC: Enforce Numpy Docstring Validation | pandas.Categorical #58064
DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065
DOC: Enforce Numpy Docstring Validation | pandas.Datetime #58066
DOC: Enforce Numpy Docstring Validation | pandas.ExcelFile through pandas.HDFStore #58067
DOC: Enforce Numpy Docstring Validation | pandas.Index #58068
* Additional Issues will be added here as they are created
For each Issue, 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: