Skip to content
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 docstring validation errors for pandas.core.groupby #60365

Open
jmalp opened this issue Nov 20, 2024 · 5 comments
Open

DOC: Fix docstring validation errors for pandas.core.groupby #60365

jmalp opened this issue Nov 20, 2024 · 5 comments

Comments

@jmalp
Copy link
Contributor

jmalp commented Nov 20, 2024

Parent Issue: #58063
pandas has a script for validating docstrings:

pandas/ci/code_checks.sh

Lines 92 to 105 in 6a7685f

-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \

Currently, some methods fail docstring validation check.
The task is:

  1. Take 1-5 methods
  2. Run: scripts/validate_docstrings.py

Example command:

scripts/validate_docstrings.py pandas.core.groupby.DataFrameGroupBy.get_group

Example output:

################################################################################
################################## Validation ##################################
################################################################################

3 Errors found for `pandas.core.groupby.DataFrameGroupBy.get_group`:
        ES01    No extended summary found
        RT03    Return value has no description
        SA01    See Also section not found
  1. Check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported. Note: Ignore ES01 errors, these are not required to be fixed.

  2. 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.

  3. Commit, push, open pull request

Please don't comment take as multiple people can work on this issue. Just comment on which methods you are going to work on.

If you're new contributor, please check the contributing guide

@srjsunny
Copy link

I'm working on these=>

-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \ 
 -i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \ 
 -i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \ 

@ensalada-de-pollo
Copy link
Contributor

ensalada-de-pollo commented Nov 20, 2024

working on:

 -i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \ 
 -i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \ 
 -i "pandas.core.groupby.SeriesGroupBy.nth PR02" \ 
 -i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \ 

@gvmmybear
Copy link
Contributor

gvmmybear commented Nov 21, 2024

I will work on:

 -i "pandas.core.groupby.SeriesGroupBy.indices SA01" \ 
 -i "pandas.core.groupby.SeriesGroupBy.plot PR02" \ 

@thedataninja1786
Copy link
Contributor

thedataninja1786 commented Nov 21, 2024

I will work on:

 -i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \ 
 -i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \ 

@githubalexliu
Copy link
Contributor

githubalexliu commented Dec 3, 2024

I will work on

 -i "pandas.core.groupby.SeriesGroupBy.sem SA01" \ 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants