pandas: DOC: fix ES01 errors in docstrings

Pandas has a script for validating docstrings:

https://github.com/pandas-dev/pandas/blob/1ca9b5871dc71353185b48362bc84e666229810d/ci/code_checks.sh#L144-L1185

Currently, some methods fail the ES01 check.

The task here is:

take 2-4 methods
run: scripts/validate_docstrings.py --format=actions --errors=ES01 method-name
check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
remove those methods from code_checks.sh
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

About this issue

Original URL
State: closed
Created 5 months ago
Comments: 15 (12 by maintainers)

Most upvoted comments

@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

mroeschke on Feb 25, 2024

I’ll take

    pandas.DataFrame.T\
    pandas.DataFrame.agg\

v-lozko on Feb 21, 2024

I’ll take

     pandas.Categorical.__array__
     pandas.Categorical.as_ordered
     pandas.Categorical.as_unordered
     pandas.Categorical.ordered
     pandas.Categorical.remove_unused_categories
     pandas.Categorical.rename_categories

williamking1221 on Feb 20, 2024