DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065

jordan-d-murphy · 2024-03-29T07:02:58Z

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

Lines 82 to 134 in c468028

    
           -i "pandas.DataFrame.__dataframe__ SA01" \ 
        
           -i "pandas.DataFrame.__iter__ SA01" \ 
        
           -i "pandas.DataFrame.assign SA01" \ 
        
           -i "pandas.DataFrame.at_time PR01" \ 
        
           -i "pandas.DataFrame.axes SA01" \ 
        
           -i "pandas.DataFrame.backfill PR01,SA01" \ 
        
           -i "pandas.DataFrame.bfill SA01" \ 
        
           -i "pandas.DataFrame.columns SA01" \ 
        
           -i "pandas.DataFrame.copy SA01" \ 
        
           -i "pandas.DataFrame.droplevel SA01" \ 
        
           -i "pandas.DataFrame.dtypes SA01" \ 
        
           -i "pandas.DataFrame.ffill SA01" \ 
        
           -i "pandas.DataFrame.first_valid_index SA01" \ 
        
           -i "pandas.DataFrame.get SA01" \ 
        
           -i "pandas.DataFrame.hist RT03" \ 
        
           -i "pandas.DataFrame.infer_objects RT03" \ 
        
           -i "pandas.DataFrame.keys SA01" \ 
        
           -i "pandas.DataFrame.kurt RT03,SA01" \ 
        
           -i "pandas.DataFrame.kurtosis RT03,SA01" \ 
        
           -i "pandas.DataFrame.last_valid_index SA01" \ 
        
           -i "pandas.DataFrame.mask RT03" \ 
        
           -i "pandas.DataFrame.max RT03" \ 
        
           -i "pandas.DataFrame.mean RT03,SA01" \ 
        
           -i "pandas.DataFrame.median RT03,SA01" \ 
        
           -i "pandas.DataFrame.min RT03" \ 
        
           -i "pandas.DataFrame.pad PR01,SA01" \ 
        
           -i "pandas.DataFrame.plot PR02,SA01" \ 
        
           -i "pandas.DataFrame.pop SA01" \ 
        
           -i "pandas.DataFrame.prod RT03" \ 
        
           -i "pandas.DataFrame.product RT03" \ 
        
           -i "pandas.DataFrame.reorder_levels SA01" \ 
        
           -i "pandas.DataFrame.sem PR01,RT03,SA01" \ 
        
           -i "pandas.DataFrame.skew RT03,SA01" \ 
        
           -i "pandas.DataFrame.sparse PR01,SA01" \ 
        
           -i "pandas.DataFrame.sparse.density SA01" \ 
        
           -i "pandas.DataFrame.sparse.from_spmatrix SA01" \ 
        
           -i "pandas.DataFrame.sparse.to_coo SA01" \ 
        
           -i "pandas.DataFrame.sparse.to_dense SA01" \ 
        
           -i "pandas.DataFrame.std PR01,RT03,SA01" \ 
        
           -i "pandas.DataFrame.sum RT03" \ 
        
           -i "pandas.DataFrame.swapaxes PR01,SA01" \ 
        
           -i "pandas.DataFrame.swaplevel SA01" \ 
        
           -i "pandas.DataFrame.to_feather SA01" \ 
        
           -i "pandas.DataFrame.to_markdown SA01" \ 
        
           -i "pandas.DataFrame.to_parquet RT03" \ 
        
           -i "pandas.DataFrame.to_period SA01" \ 
        
           -i "pandas.DataFrame.to_timestamp SA01" \ 
        
           -i "pandas.DataFrame.tz_convert SA01" \ 
        
           -i "pandas.DataFrame.tz_localize SA01" \ 
        
           -i "pandas.DataFrame.unstack RT03" \ 
        
           -i "pandas.DataFrame.value_counts RT03" \ 
        
           -i "pandas.DataFrame.var PR01,RT03,SA01" \ 
        
           -i "pandas.DataFrame.where RT03" \

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:

################################################################################
################################## 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 : )

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:

YashpalAhlawat · 2024-03-29T18:54:51Z

opened a fix for pandas.DataFrame.where

Aloqeely · 2024-03-31T00:12:01Z

Going to remove pandas.DataFrame.swapaxes, pandas.DataFrame.pad and pandas.DataFrame.backfill which are all deprecated

bergnerjonas · 2024-03-31T21:20:53Z

Will work on pandas.DataFrame.unstack, pandas.DataFrame.value_counts and pandas.DataFrame.tz_localize

bergnerjonas · 2024-04-01T10:26:12Z

Continue with pandas.DataFrame.to_period ,pandas.DataFrame.to_timestamp ,pandas.DataFrame.tz_convert

…tamp, pandas.DataFrame.tz_convert #58065 (#58101) * Add See Also section to to_period method. * Add See Also section to to_timestamp method. * Add See Also section to tz_convert method. * fix typo in to_timestamp * Fix formatting of See Also * Remove fixed methods from code check ignore list. * Fix formatting * Revert accidentally included docstring changes. * fix merge issues * Fix pre commit hooks * Fix line break issues.

shriyakalakata · 2024-04-02T03:45:31Z

Working on pandas.DataFrame.assign, pandas.DataFrame.bfill, and pandas.DataFrame.ffill

shriyakalakata · 2024-04-17T18:38:19Z

Will work on pandas.DataFrame.get and pandas.DataFrame.dtypes

shriyakalakata · 2024-04-17T20:18:59Z

Will work on pandas.DataFrame.copy, pandas.DataFrame.first_valid_index, pandas.DataFrame.last_valid_index, and pandas.DataFrame.keys

gboeker · 2024-04-18T16:29:30Z

Working on pandas.DataFrame.sparse, pandas.DataFrame.sparse.density, pandas.DataFrame.sparse.from_spmatrix, pandas.DataFrame.sparse.to_coo, and pandas.DataFrame.sparse.to_dense

KeiOshima · 2024-04-19T05:22:42Z

Working on:

pandas.DataFrame.columns
pandas.DataFrame.pop

KeiOshima · 2024-04-21T18:31:29Z

working on:

pandas.DataFrame.to_feather

gboeker · 2024-04-21T19:31:06Z

working on

pandas.DataFrame.mean
pandas.DataFrame.median
pandas.DataFrame.plot
pandas.DataFrame.pop

gboeker · 2024-04-21T21:24:54Z

working on

pandas.DataFrame.__iter__
pandas.DataFrame.columns
pandas.DataFrame.droplevel

Brett-Dixon · 2024-05-26T00:04:30Z

I will check out:

    -i "pandas.DataFrame.max RT03" \
    -i "pandas.DataFrame.mean RT03,SA01" \
    -i "pandas.DataFrame.median RT03,SA01" \
    -i "pandas.DataFrame.min RT03" \

anishfish2 · 2024-05-27T07:11:56Z

I'll check out:

        -i "pandas.DataFrame.plot PR02,SA01" \

@mroeschke, @Aloqeely is there anything else I need to add?

enesyesil · 2024-06-21T17:21:10Z

Hey, is this issue open? would like contribute as a beginner. Thank you

Aloqeely · 2024-06-21T17:28:57Z

Yes it's still open. Good luck!

shriyase · 2024-06-21T19:54:04Z

Hey, I'd like to contribute to this issue if it's still open

Aloqeely · 2024-06-21T20:06:09Z

Yes! You can see ci/code_checks.sh for all the docstrings that need to be fixed.

shriyase · 2024-06-21T20:22:45Z

I will work on -i "pandas.DataFrame.value_counts RT03" \,
-i "pandas.DataFrame.var PR01,RT03,SA01" \,
-i "pandas.DataFrame.where RT03" \, -i "pandas.DataFrame.backfill PR01,SA01" \ and
-i "pandas.DataFrame.bfill SA01" \

shriyase · 2024-06-22T01:41:00Z

Is it only that the methods from the original issue post need to be checked? Or any methods in ci/code_checks.sh? Also when i check a few of the methods, I get additional errors that aren't listed in the documentation? Do I add those error codes too?

Aloqeely · 2024-06-22T08:11:11Z

You can fix any method in that file.

Also when i check a few of the methods, I get additional errors that aren't listed in the documentation?

Not sure what you mean by additional errors.

CollinClifford · 2024-06-23T14:49:53Z

Does the validate_docstrings.py validation not work for anyone else? I'm getting an error on line 217, stating that there isn't enough values to unpack (expected 4 got 1) for all of the docstrings I've checked.

Aloqeely · 2024-06-24T21:23:28Z

It works for me. Can you post the command you ran and the error message?

deekapila · 2024-07-10T20:18:23Z

take

ktseng4096 · 2024-07-15T22:14:33Z

I'll work on pandas.Series.to_dict and pandas.Series.to_frame

Aditya060 · 2024-07-16T21:19:57Z

Does the validate_docstrings.py validation not work for anyone else? I'm getting an error on line 217, stating that there isn't enough values to unpack (expected 4 got 1) for all of the docstrings I've checked.

Try to install flake8 in the virtual environment that you are working in. That fixed the issue for me.

deekapila · 2024-08-06T19:48:33Z

hi, I have a question. Is this issue only for pandas.DataFrame.xxxx methods or we can can use this to fix other as well. If there are no errors for pandas.DataFrame.xxx method, should we remove this from code_checks.sh ? e.g. pandas.DataFrae.copy says 'Docstring for "pandas.DataFrame.copy: correct. :)

jordan-d-murphy mentioned this issue Mar 29, 2024

DOC: Enforce Numpy Docstring Validation (Parent Issue) #58063

Open

YashpalAhlawat mentioned this issue Mar 29, 2024

DOC: docstring fix for pandas.DataFrame.where method #58076

Merged

5 tasks

Aloqeely mentioned this issue Mar 31, 2024

CI: Remove deprecated methods from code_checks.sh #58090

Merged

5 tasks

bergnerjonas mentioned this issue Mar 31, 2024

DOC: Fix docstring errors for pandas.DataFrame.unstack, pandas.DataFrame.value_counts and pandas.DataFrame.tz_localize #58097

Merged

4 tasks

bergnerjonas mentioned this issue Apr 1, 2024

DOC: fix docstring for DataFrame.to_period, pandas.DataFrame.to_timestamp, pandas.DataFrame.tz_convert #58065 #58101

Merged

4 tasks

v-lozko mentioned this issue Apr 1, 2024

DOC: Fix docstring error for pandas.DataFrame.axes #58102

Closed

4 tasks

shriyakalakata mentioned this issue Apr 2, 2024

DOC: Remove deprecated methods from code_checks.sh #58115

Merged

5 tasks

v-lozko mentioned this issue Apr 11, 2024

DOC: Fix docstring error for pandas.DataFrame.axes #58223

Merged

4 tasks

shriyakalakata mentioned this issue Apr 17, 2024

DOC: Remove deprecated methods from code_checks.sh #58294

Merged

5 tasks

shriyakalakata mentioned this issue Apr 17, 2024

DOC: Remove deprecated methods w/ SA01 errors from code_checks.sh #58298

Merged

5 tasks

gboeker mentioned this issue Apr 18, 2024

DOC: Update DataFrame.sparse methods' docstring to pass docstring validation #58323

Merged

1 task

KeiOshima mentioned this issue Apr 21, 2024

Doc: Fixing SA01 error for DataFrame: pop and columns #58359

Merged

5 tasks

gboeker mentioned this issue Apr 21, 2024

DOC: Enforce Numpy Docstring Validation for DataFrame #58362

Closed

1 task

Nrezhang added a commit to Nrezhang/pandas that referenced this issue Apr 21, 2024

DOC: fix docstring for DataFrame.pop pandas-dev#58065

66ac9d5

Nrezhang mentioned this issue Apr 21, 2024

DOC: fix docstring for DataFrame.pop #58065 #58363

Closed

5 tasks

gboeker mentioned this issue Apr 21, 2024

DOC: Fix SA01 Docstring Errors for DataFrame #58364

Merged

1 task

KeiOshima mentioned this issue Apr 23, 2024

DOC: fixinf SA01 issue for DataFrame.to_feather #58378

Merged

5 tasks

Aloqeely mentioned this issue May 23, 2024

DOC: Docstrings missing from .py files in Sphinxext docs folder #58812

Open

1 task

mroeschke added Docs good first issue labels May 23, 2024

anishfish2 mentioned this issue May 27, 2024

DOC: Fix docstring error SA01 for pandas.Dataframe.plot, pandas.Series.plot, pandas.core.groupby.DataFrameGroupBy.plot, pandas.core.groupby.SeriesGroupBy.plot #58842

Merged

6 tasks

Brett-Dixon mentioned this issue Jun 6, 2024

DOC: added see also to docstrings in mean and median #58951

Merged

phofl mentioned this issue Jun 23, 2024

Working on documentation build errors phofl/pydata-yerevan-sprint#3

Open

github-actions bot assigned deekapila Jul 10, 2024

BorjaElizalde mentioned this issue Jul 11, 2024

modified the automatically generated docstring to include the return … #59229

Merged

5 tasks

Aditya060 mentioned this issue Jul 17, 2024

Removed SA01 error for pandas.Series.to_frame. Added See Also section… #59262

Merged

4 tasks

mattbest mentioned this issue Jul 17, 2024

DOC: Fix numpy docstring validation errors in pandas.Series.skew #59266

Merged

mroeschke closed this as completed in #59262 Jul 17, 2024

ktseng4096 mentioned this issue Jul 18, 2024

DOC: add See Also section to series.to_dict #59269

Merged

sukriti1 mentioned this issue Jul 28, 2024

Doc: Fix docstring SA01 error for pandas.core.groupby median and pandas.core.resample median #59339

Merged

deekapila removed their assignment Aug 6, 2024

ktseng4096 mentioned this issue Aug 23, 2024

DOC: add Return Value Description to DataFrame.min #59586

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065

DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065

jordan-d-murphy commented Mar 29, 2024 •

edited

Loading

YashpalAhlawat commented Mar 29, 2024

Aloqeely commented Mar 31, 2024

bergnerjonas commented Mar 31, 2024 •

edited

Loading

bergnerjonas commented Apr 1, 2024

shriyakalakata commented Apr 2, 2024

shriyakalakata commented Apr 17, 2024 •

edited

Loading

shriyakalakata commented Apr 17, 2024 •

edited

Loading

gboeker commented Apr 18, 2024

KeiOshima commented Apr 19, 2024 •

edited

Loading

KeiOshima commented Apr 21, 2024 •

edited

Loading

gboeker commented Apr 21, 2024

gboeker commented Apr 21, 2024 •

edited

Loading

Brett-Dixon commented May 26, 2024

anishfish2 commented May 27, 2024 •

edited

Loading

enesyesil commented Jun 21, 2024

Aloqeely commented Jun 21, 2024

shriyase commented Jun 21, 2024

Aloqeely commented Jun 21, 2024

shriyase commented Jun 21, 2024

shriyase commented Jun 22, 2024

Aloqeely commented Jun 22, 2024

CollinClifford commented Jun 23, 2024

Aloqeely commented Jun 24, 2024

deekapila commented Jul 10, 2024

ktseng4096 commented Jul 15, 2024

Aditya060 commented Jul 16, 2024

deekapila commented Aug 6, 2024

DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065

DOC: Enforce Numpy Docstring Validation | pandas.DataFrame #58065

Comments

jordan-d-murphy commented Mar 29, 2024 • edited Loading

pandas.DataFrame

YashpalAhlawat commented Mar 29, 2024

Aloqeely commented Mar 31, 2024

bergnerjonas commented Mar 31, 2024 • edited Loading

bergnerjonas commented Apr 1, 2024

shriyakalakata commented Apr 2, 2024

shriyakalakata commented Apr 17, 2024 • edited Loading

shriyakalakata commented Apr 17, 2024 • edited Loading

gboeker commented Apr 18, 2024

KeiOshima commented Apr 19, 2024 • edited Loading

KeiOshima commented Apr 21, 2024 • edited Loading

gboeker commented Apr 21, 2024

gboeker commented Apr 21, 2024 • edited Loading

Brett-Dixon commented May 26, 2024

anishfish2 commented May 27, 2024 • edited Loading

enesyesil commented Jun 21, 2024

Aloqeely commented Jun 21, 2024

shriyase commented Jun 21, 2024

Aloqeely commented Jun 21, 2024

shriyase commented Jun 21, 2024

shriyase commented Jun 22, 2024

Aloqeely commented Jun 22, 2024

CollinClifford commented Jun 23, 2024

Aloqeely commented Jun 24, 2024

deekapila commented Jul 10, 2024

ktseng4096 commented Jul 15, 2024

Aditya060 commented Jul 16, 2024

deekapila commented Aug 6, 2024

jordan-d-murphy commented Mar 29, 2024 •

edited

Loading

bergnerjonas commented Mar 31, 2024 •

edited

Loading

shriyakalakata commented Apr 17, 2024 •

edited

Loading

shriyakalakata commented Apr 17, 2024 •

edited

Loading

KeiOshima commented Apr 19, 2024 •

edited

Loading

KeiOshima commented Apr 21, 2024 •

edited

Loading

gboeker commented Apr 21, 2024 •

edited

Loading

anishfish2 commented May 27, 2024 •

edited

Loading