DOC: Enforce Numpy Docstring Validation | pandas.Index #58068

jordan-d-murphy · 2024-03-29T07:18:05Z

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

Lines 182 to 230 in c468028

    
           -i "pandas.Index PR07" \ 
        
           -i "pandas.Index.T SA01" \ 
        
           -i "pandas.Index.append PR07,RT03,SA01" \ 
        
           -i "pandas.Index.astype SA01" \ 
        
           -i "pandas.Index.copy PR07,SA01" \ 
        
           -i "pandas.Index.difference PR07,RT03,SA01" \ 
        
           -i "pandas.Index.drop PR07,SA01" \ 
        
           -i "pandas.Index.drop_duplicates RT03" \ 
        
           -i "pandas.Index.droplevel RT03,SA01" \ 
        
           -i "pandas.Index.dropna RT03,SA01" \ 
        
           -i "pandas.Index.dtype SA01" \ 
        
           -i "pandas.Index.duplicated RT03" \ 
        
           -i "pandas.Index.empty GL08" \ 
        
           -i "pandas.Index.equals SA01" \ 
        
           -i "pandas.Index.fillna RT03" \ 
        
           -i "pandas.Index.get_indexer PR07,SA01" \ 
        
           -i "pandas.Index.get_indexer_for PR01,SA01" \ 
        
           -i "pandas.Index.get_indexer_non_unique PR07,SA01" \ 
        
           -i "pandas.Index.get_loc PR07,RT03,SA01" \ 
        
           -i "pandas.Index.get_slice_bound PR07" \ 
        
           -i "pandas.Index.hasnans SA01" \ 
        
           -i "pandas.Index.identical PR01,SA01" \ 
        
           -i "pandas.Index.inferred_type SA01" \ 
        
           -i "pandas.Index.insert PR07,RT03,SA01" \ 
        
           -i "pandas.Index.intersection PR07,RT03,SA01" \ 
        
           -i "pandas.Index.item SA01" \ 
        
           -i "pandas.Index.join PR07,RT03,SA01" \ 
        
           -i "pandas.Index.map SA01" \ 
        
           -i "pandas.Index.memory_usage RT03" \ 
        
           -i "pandas.Index.name SA01" \ 
        
           -i "pandas.Index.names GL08" \ 
        
           -i "pandas.Index.nbytes SA01" \ 
        
           -i "pandas.Index.ndim SA01" \ 
        
           -i "pandas.Index.nunique RT03" \ 
        
           -i "pandas.Index.putmask PR01,RT03" \ 
        
           -i "pandas.Index.ravel PR01,RT03" \ 
        
           -i "pandas.Index.reindex PR07" \ 
        
           -i "pandas.Index.shape SA01" \ 
        
           -i "pandas.Index.size SA01" \ 
        
           -i "pandas.Index.slice_indexer PR07,RT03,SA01" \ 
        
           -i "pandas.Index.slice_locs RT03" \ 
        
           -i "pandas.Index.str PR01,SA01" \ 
        
           -i "pandas.Index.symmetric_difference PR07,RT03,SA01" \ 
        
           -i "pandas.Index.take PR01,PR07" \ 
        
           -i "pandas.Index.to_list RT03" \ 
        
           -i "pandas.Index.union PR07,RT03,SA01" \ 
        
           -i "pandas.Index.unique RT03" \ 
        
           -i "pandas.Index.value_counts RT03" \ 
        
           -i "pandas.Index.view GL08" \

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:

Aloqeely · 2024-03-31T00:00:38Z

For some reason, when I run the command on pandas.Index.str I get the following error:

UnicodeDecodeError: 'charmap' codec can't decode byte 0x9d in position 3662: character maps to <undefined>

sunwooma · 2024-04-03T20:58:27Z

Can I be assigned to this?

Aloqeely · 2024-04-03T22:50:10Z

Can I be assigned to this?

Of course! As Mr. Murphy said, you don't need to ask for permission, just comment which methods you will be working on

KeiOshima · 2024-04-19T02:40:51Z

Will work on

pandas.Index.size
pandas.Index.shape
pandas.Index.ndim

KeiOshima · 2024-04-20T16:58:03Z

will work on

pandas.Index.name
pandas.Index.dtype 
pandas.Index.equals

shriyakalakata · 2024-04-20T20:27:42Z

Working on pandas.Index.map, pandas.Index.hasnans, pandas.Index.nbytes,

Nrezhang · 2024-04-21T16:17:40Z

working on pandas.Index.astype

sunwooma · 2024-04-21T17:43:30Z

working on pandas.DataFrame.to_parquet, pandas.DatetimeIndex.hour

KeiOshima · 2024-04-22T19:06:56Z

working on

pandas.Index.empty 
pandas.Index.T

tuhinsharma121 · 2024-04-24T07:22:53Z

working on

-i "pandas.Index.to_list  RT03" \
-i "pandas.Index.unique RT03" \ 
-i "pandas.Index.item SA01" \

tuhinsharma121 · 2024-04-25T06:12:25Z

working on

-i "pandas.Index.fillna RT03" \

KeiOshima · 2024-04-25T19:17:41Z

working on

 -i "pandas.Index.duplicated RT03" \ 
 -i "pandas.Index.nunique RT03" \

KeiOshima · 2024-04-25T19:33:46Z

working on

pandas.Index.memory_usage RT03
pandas.Index.drop_duplicates RT03

shriyakalakata · 2024-04-25T19:38:22Z

Working on

-i "pandas.Index.droplevel RT03,SA01" \
-i "pandas.Index.dropna RT03,SA01" \
-i "pandas.Index.fillna RT03" \

shriyakalakata · 2024-04-25T20:08:47Z

Working on

-i "pandas.Index.inferred_type SA01" \
-i "pandas.Index.item SA01" \
-i "pandas.Index.slice_locs RT03" \

shriyakalakata · 2024-04-27T16:28:05Z

Working on

 -i "pandas.Index.insert PR07,RT03,SA01" \ 
 -i "pandas.Index.intersection PR07,RT03,SA01" \

KeiOshima · 2024-04-27T16:42:22Z

working on

 -i "pandas.Index.get_indexer_non_unique PR07,SA01" \ 
-i "pandas.Index.get_indexer PR07,SA01" \

shriyakalakata · 2024-04-27T16:44:40Z

Working on

 -i "pandas.Index.symmetric_difference PR07,RT03,SA01" \ 
 -i "pandas.Index.union PR07,RT03,SA01" \

shriyakalakata · 2024-04-29T01:41:07Z

Working on

 -i "pandas.Index.join PR07,RT03,SA01" \

aBiR1D · 2024-04-29T20:25:54Z

Working on

-i "pandas.Index PR07" \

tuhinsharma121 · 2024-04-30T03:37:00Z

@mroeschke @jordan-d-murphy This issue is not closed yet. We need to keep it open. Following items are still remaining

        -i "pandas.Index PR07" \
        -i "pandas.Index.append PR07,RT03,SA01" \
        -i "pandas.Index.difference PR07,RT03,SA01" \
        -i "pandas.Index.get_indexer PR07,SA01" \
        -i "pandas.Index.get_indexer_for PR01,SA01" \
        -i "pandas.Index.get_indexer_non_unique PR07,SA01" \
        -i "pandas.Index.get_loc PR07,RT03,SA01" \
        -i "pandas.Index.join PR07,RT03,SA01" \
        -i "pandas.Index.names GL08" \
        -i "pandas.Index.putmask PR01,RT03" \
        -i "pandas.Index.ravel PR01,RT03" \
        -i "pandas.Index.slice_indexer PR07,RT03,SA01" \
        -i "pandas.Index.str PR01,SA01" \
        -i "pandas.Index.take PR01,PR07" \
        -i "pandas.Index.view GL08" \

tuhinsharma121 · 2024-04-30T06:31:00Z

I am working on the following

-i "pandas.Index.view GL08" \
-i "pandas.Index.take PR01,PR07" \
-i "pandas.Index.slice_indexer PR07,RT03,SA01" \

tuhinsharma121 · 2024-04-30T18:02:00Z

I am working on the following

        -i "pandas.Index.get_indexer PR07,SA01" \
        -i "pandas.Index.get_indexer_for PR01,SA01" \
        -i "pandas.Index.get_indexer_non_unique PR07,SA01" \
        -i "pandas.Index.get_loc PR07,RT03,SA01" \
        -i "pandas.Index.putmask PR01,RT03" \

tuhinsharma121 · 2024-05-02T18:45:34Z

workin on

        -i "pandas.Index.join PR07,RT03,SA01" \
        -i "pandas.Index.ravel PR01,RT03" \
        -i "pandas.Index.str PR01,SA01" \
        -i "pandas.Index.names GL08" \

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

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

Open

KeiOshima mentioned this issue Apr 20, 2024

DOC: fixing SA01 errors for index.size, shape, and ndim. #58333

Merged

5 tasks

shriyakalakata mentioned this issue Apr 20, 2024

DOC: Fix SA01 errors for Index.hasnans, Index.map, Index.nbytes #58343

Merged

5 tasks

Nrezhang mentioned this issue Apr 21, 2024

DOC: Fix SA01 errors for pandas.Index.astype #58352

Merged

5 tasks

KeiOshima mentioned this issue Apr 21, 2024

DOC: fixing SA01 errors for Index: name, dtype, and equals #58355

Merged

5 tasks

This was referenced Apr 21, 2024

BUG - False drops groupings #58361

Closed

DOC-Enforce Numpy Docstring Validation #58372

Closed

This was referenced Apr 24, 2024

DOC: Enforce Numpy Docstring Validation for pandas.Index.to_list #58398

Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.unique #58399

Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.item #58400

Merged

tuhinsharma121 mentioned this issue Apr 25, 2024

DOC: Enforce Numpy Docstring Validation for pandas.Index.fillna #58417

Merged

KeiOshima mentioned this issue Apr 25, 2024

DOC: fixing SA01 error for Index: T and empty #58430

Merged

5 tasks

KeiOshima mentioned this issue Apr 25, 2024

DOC: fixing RT03 erros for Index: duplicated and nunique #58432

Merged

5 tasks

shriyakalakata mentioned this issue Apr 25, 2024

DOC: Fix RT03 and SA01 errors for Index.droplevel, Index.dropna #58433

Merged

2 tasks

KeiOshima mentioned this issue Apr 25, 2024

DOC: ficing RT03 errors for Index: drop_duplicates and memory_usage #58434

Merged

5 tasks

shriyakalakata mentioned this issue Apr 27, 2024

Fix errors for Index.drop, Index.reindex #58454

Merged

2 tasks

shriyakalakata mentioned this issue Apr 27, 2024

Fix PR07,RT03,SA01 errors for Index.insert, Index.intersection #58456

Merged

2 tasks

shriyakalakata mentioned this issue Apr 27, 2024

Fix PR07,RT03,SA01 errors for Index.union, Index.symmetric_difference #58457

Merged

2 tasks

shriyakalakata mentioned this issue Apr 29, 2024

Fix PR07,RT03,SA01 errors for Index.join #58469

Closed

2 tasks

aBiR1D mentioned this issue Apr 29, 2024

Fix PR07 error for pandas.Index #58478

Closed

2 tasks

mroeschke closed this as completed in #58457 Apr 29, 2024

This was referenced Apr 30, 2024

DOC: Enforce Numpy Docstring Validation for pandas.Index.view #58486

Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.take #58489

Merged

DOC: Enforce Numpy Docstring Validation for pandas.Index.sliece_indexer #58490

Merged

mroeschke reopened this Apr 30, 2024

tuhinsharma121 mentioned this issue May 12, 2024

DOC: add PR07 for pandas.Index #58682

Merged

1 task

mroeschke closed this as completed in #58682 May 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Enforce Numpy Docstring Validation | pandas.Index #58068

DOC: Enforce Numpy Docstring Validation | pandas.Index #58068

jordan-d-murphy commented Mar 29, 2024 •

edited

Loading

Aloqeely commented Mar 31, 2024

sunwooma commented Apr 3, 2024

Aloqeely commented Apr 3, 2024

KeiOshima commented Apr 19, 2024

KeiOshima commented Apr 20, 2024 •

edited

Loading

shriyakalakata commented Apr 20, 2024

Nrezhang commented Apr 21, 2024 •

edited

Loading

sunwooma commented Apr 21, 2024

KeiOshima commented Apr 22, 2024

tuhinsharma121 commented Apr 24, 2024 •

edited

Loading

tuhinsharma121 commented Apr 25, 2024

KeiOshima commented Apr 25, 2024 •

edited

Loading

KeiOshima commented Apr 25, 2024

shriyakalakata commented Apr 25, 2024

shriyakalakata commented Apr 25, 2024

shriyakalakata commented Apr 27, 2024

KeiOshima commented Apr 27, 2024

shriyakalakata commented Apr 27, 2024

shriyakalakata commented Apr 29, 2024 •

edited

Loading

aBiR1D commented Apr 29, 2024

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented May 2, 2024 •

edited

Loading

DOC: Enforce Numpy Docstring Validation | pandas.Index #58068

DOC: Enforce Numpy Docstring Validation | pandas.Index #58068

Comments

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

pandas.Index

Aloqeely commented Mar 31, 2024

sunwooma commented Apr 3, 2024

Aloqeely commented Apr 3, 2024

KeiOshima commented Apr 19, 2024

KeiOshima commented Apr 20, 2024 • edited Loading

shriyakalakata commented Apr 20, 2024

Nrezhang commented Apr 21, 2024 • edited Loading

sunwooma commented Apr 21, 2024

KeiOshima commented Apr 22, 2024

tuhinsharma121 commented Apr 24, 2024 • edited Loading

tuhinsharma121 commented Apr 25, 2024

KeiOshima commented Apr 25, 2024 • edited Loading

KeiOshima commented Apr 25, 2024

shriyakalakata commented Apr 25, 2024

shriyakalakata commented Apr 25, 2024

shriyakalakata commented Apr 27, 2024

KeiOshima commented Apr 27, 2024

shriyakalakata commented Apr 27, 2024

shriyakalakata commented Apr 29, 2024 • edited Loading

aBiR1D commented Apr 29, 2024

Working on

tuhinsharma121 commented Apr 30, 2024 • edited Loading

tuhinsharma121 commented Apr 30, 2024 • edited Loading

tuhinsharma121 commented Apr 30, 2024 • edited Loading

tuhinsharma121 commented May 2, 2024 • edited Loading

jordan-d-murphy commented Mar 29, 2024 •

edited

Loading

KeiOshima commented Apr 20, 2024 •

edited

Loading

Nrezhang commented Apr 21, 2024 •

edited

Loading

tuhinsharma121 commented Apr 24, 2024 •

edited

Loading

KeiOshima commented Apr 25, 2024 •

edited

Loading

shriyakalakata commented Apr 29, 2024 •

edited

Loading

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented Apr 30, 2024 •

edited

Loading

tuhinsharma121 commented May 2, 2024 •

edited

Loading