-
-
Notifications
You must be signed in to change notification settings - Fork 18.3k
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: fix ES01 errors in docstrings #57440
Comments
I don't have permission to add them, but this could probably use some labels:
|
addresses #57359 |
I'll take
|
I'll take
|
There is a bit of a circular error happening with this task. Running scripts/validate_docstrings.py --format=actions --errors=ES01 method-name generates an error saying that an extended summary is needed. However, once one is added it states that extended summary is not one of the allowed sections |
Opened a fix for |
Opened fix for to_csv method. Will take more once this get merged. |
Raised a PR for fix of ES01 for below methods:
|
opened a PR for |
@jordan-d-murphy what do you think about intentionally not enforcing ES01 for the docstrings? In my opinion if they just redescribe the parameter section or tell something that would be clearer in an example, I'm skeptical of it's value |
That's a fair point, if it's not adding enough value to be worth enforcing, I can open a PR to remove the block that enforces it. @mroeschke |
@jordan-d-murphy will this issue then be closed because of #57625? I had taken a couple methods to update but haven't addressed them yet because of an open question |
Closing due to #57625 |
yup @v-lozko |
Opened DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063 as a parent issue for fixing docstrings based on the refactoring in code_checks.sh Feel free to swing by and help out! 🙂 |
Pandas has a script for validating docstrings:
pandas/ci/code_checks.sh
Lines 144 to 1185 in 1ca9b58
Currently, some methods fail the ES01 check.
The task here is:
method-name
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
The text was updated successfully, but these errors were encountered: