DOC: Enforce Numpy Docstring Validation | pandas.DataFrame

[jordan-d-murphy]

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

pandas/ci/code_checks.sh

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:

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 for the inspiration for this issue!

[YashpalAhlawat]

opened a fix for pandas.DataFrame.where

[Aloqeely]

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

[bergnerjonas]

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

[bergnerjonas]

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

[shriyakalakata]

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

[shriyakalakata]

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