DOC: Enforce Numpy Docstring Validation | pandas.api.extensions.ExtensionArray

[gboeker]

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.api.extensions.ExtensionArray

pandas/ci/code_checks.sh

Lines 590 to 620 in c468028

	-i "pandas.api.extensions.ExtensionArray SA01" \
	-i "pandas.api.extensions.ExtensionArray._accumulate RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \
	-i "pandas.api.extensions.ExtensionArray._formatter SA01" \
	-i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \
	-i "pandas.api.extensions.ExtensionArray._from_sequence_of_strings SA01" \
	-i "pandas.api.extensions.ExtensionArray._hash_pandas_object RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray._pad_or_backfill PR01,RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray._reduce RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray._values_for_factorize SA01" \
	-i "pandas.api.extensions.ExtensionArray.astype SA01" \
	-i "pandas.api.extensions.ExtensionArray.copy RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.dropna RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.dtype SA01" \
	-i "pandas.api.extensions.ExtensionArray.duplicated RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.equals SA01" \
	-i "pandas.api.extensions.ExtensionArray.fillna SA01" \
	-i "pandas.api.extensions.ExtensionArray.insert PR07,RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.interpolate PR01,SA01" \
	-i "pandas.api.extensions.ExtensionArray.isin PR07,RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.isna SA01" \
	-i "pandas.api.extensions.ExtensionArray.nbytes SA01" \
	-i "pandas.api.extensions.ExtensionArray.ndim SA01" \
	-i "pandas.api.extensions.ExtensionArray.ravel RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.shape SA01" \
	-i "pandas.api.extensions.ExtensionArray.shift SA01" \
	-i "pandas.api.extensions.ExtensionArray.take RT03" \
	-i "pandas.api.extensions.ExtensionArray.tolist RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.unique RT03,SA01" \
	-i "pandas.api.extensions.ExtensionArray.view SA01" \
	-i "pandas.api.extensions.register_extension_dtype SA01" \

The task is:

1. take 1-5 methods

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

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

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

5. 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 @jordan-d-murphy for the inspiration for this issue!

[gboeker]

take

 -i "pandas.api.extensions.ExtensionArray SA01" \ 
 -i "pandas.api.extensions.ExtensionArray._accumulate RT03,SA01" \ 
 -i "pandas.api.extensions.ExtensionArray._concat_same_type PR07,SA01" \ 
 -i "pandas.api.extensions.ExtensionArray._formatter SA01" \ 
 -i "pandas.api.extensions.ExtensionArray._from_sequence SA01" \ 

[tuhinsharma121]

working on

 -i "pandas.api.extensions.register_extension_dtype SA01" \