DOC: Enforce Numpy Docstring Validation | pandas.api.types

[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 621 to 662 in c468028

	-i "pandas.api.indexers.BaseIndexer PR01,SA01" \
	-i "pandas.api.indexers.FixedForwardWindowIndexer PR01,SA01" \
	-i "pandas.api.indexers.VariableOffsetWindowIndexer PR01,SA01" \
	-i "pandas.api.interchange.from_dataframe RT03,SA01" \
	-i "pandas.api.types.infer_dtype PR07,SA01" \
	-i "pandas.api.types.is_any_real_numeric_dtype SA01" \
	-i "pandas.api.types.is_bool PR01,SA01" \
	-i "pandas.api.types.is_bool_dtype SA01" \
	-i "pandas.api.types.is_categorical_dtype SA01" \
	-i "pandas.api.types.is_complex PR01,SA01" \
	-i "pandas.api.types.is_complex_dtype SA01" \
	-i "pandas.api.types.is_datetime64_any_dtype SA01" \
	-i "pandas.api.types.is_datetime64_dtype SA01" \
	-i "pandas.api.types.is_datetime64_ns_dtype SA01" \
	-i "pandas.api.types.is_datetime64tz_dtype SA01" \
	-i "pandas.api.types.is_dict_like PR07,SA01" \
	-i "pandas.api.types.is_extension_array_dtype SA01" \
	-i "pandas.api.types.is_file_like PR07,SA01" \
	-i "pandas.api.types.is_float PR01,SA01" \
	-i "pandas.api.types.is_float_dtype SA01" \
	-i "pandas.api.types.is_hashable PR01,RT03,SA01" \
	-i "pandas.api.types.is_int64_dtype SA01" \
	-i "pandas.api.types.is_integer PR01,SA01" \
	-i "pandas.api.types.is_integer_dtype SA01" \
	-i "pandas.api.types.is_interval_dtype SA01" \
	-i "pandas.api.types.is_iterator PR07,SA01" \
	-i "pandas.api.types.is_list_like SA01" \
	-i "pandas.api.types.is_named_tuple PR07,SA01" \
	-i "pandas.api.types.is_numeric_dtype SA01" \
	-i "pandas.api.types.is_object_dtype SA01" \
	-i "pandas.api.types.is_period_dtype SA01" \
	-i "pandas.api.types.is_re PR07,SA01" \
	-i "pandas.api.types.is_re_compilable PR07,SA01" \
	-i "pandas.api.types.is_scalar SA01" \
	-i "pandas.api.types.is_signed_integer_dtype SA01" \
	-i "pandas.api.types.is_sparse SA01" \
	-i "pandas.api.types.is_string_dtype SA01" \
	-i "pandas.api.types.is_timedelta64_dtype SA01" \
	-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
	-i "pandas.api.types.is_unsigned_integer_dtype SA01" \
	-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
	-i "pandas.api.types.union_categoricals RT03,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!

[tuhinsharma121]

working on

-i "pandas.api.indexers.BaseIndexer PR01,SA01" \