DOC: fix SA05 errors in docstrings

[jordan-d-murphy]

Pandas has a script for validating docstrings:

pandas/ci/code_checks.sh

Lines 145 to 206 in 1d7aedc

	MSG='Partially validate docstrings (SA05)' ; echo $MSG
	$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \
	pandas.DataFrame.agg\
	pandas.DataFrame.aggregate\
	pandas.DataFrame.boxplot\
	pandas.PeriodIndex.asfreq\
	pandas.arrays.ArrowStringArray\
	pandas.arrays.StringArray\
	pandas.core.groupby.DataFrameGroupBy.first\
	pandas.core.groupby.DataFrameGroupBy.last\
	pandas.core.groupby.SeriesGroupBy.first\
	pandas.core.groupby.SeriesGroupBy.last\
	pandas.core.resample.Resampler.first\
	pandas.core.resample.Resampler.last\
	pandas.core.window.ewm.ExponentialMovingWindow.corr\
	pandas.core.window.ewm.ExponentialMovingWindow.cov\
	pandas.core.window.ewm.ExponentialMovingWindow.mean\
	pandas.core.window.ewm.ExponentialMovingWindow.std\
	pandas.core.window.ewm.ExponentialMovingWindow.sum\
	pandas.core.window.ewm.ExponentialMovingWindow.var\
	pandas.core.window.expanding.Expanding.aggregate\
	pandas.core.window.expanding.Expanding.apply\
	pandas.core.window.expanding.Expanding.corr\
	pandas.core.window.expanding.Expanding.count\
	pandas.core.window.expanding.Expanding.cov\
	pandas.core.window.expanding.Expanding.kurt\
	pandas.core.window.expanding.Expanding.max\
	pandas.core.window.expanding.Expanding.mean\
	pandas.core.window.expanding.Expanding.median\
	pandas.core.window.expanding.Expanding.min\
	pandas.core.window.expanding.Expanding.quantile\
	pandas.core.window.expanding.Expanding.rank\
	pandas.core.window.expanding.Expanding.sem\
	pandas.core.window.expanding.Expanding.skew\
	pandas.core.window.expanding.Expanding.std\
	pandas.core.window.expanding.Expanding.sum\
	pandas.core.window.expanding.Expanding.var\
	pandas.core.window.rolling.Rolling.aggregate\
	pandas.core.window.rolling.Rolling.apply\
	pandas.core.window.rolling.Rolling.corr\
	pandas.core.window.rolling.Rolling.count\
	pandas.core.window.rolling.Rolling.cov\
	pandas.core.window.rolling.Rolling.kurt\
	pandas.core.window.rolling.Rolling.max\
	pandas.core.window.rolling.Rolling.mean\
	pandas.core.window.rolling.Rolling.median\
	pandas.core.window.rolling.Rolling.min\
	pandas.core.window.rolling.Rolling.quantile\
	pandas.core.window.rolling.Rolling.rank\
	pandas.core.window.rolling.Rolling.sem\
	pandas.core.window.rolling.Rolling.skew\
	pandas.core.window.rolling.Rolling.std\
	pandas.core.window.rolling.Rolling.sum\
	pandas.core.window.rolling.Rolling.var\
	pandas.core.window.rolling.Window.mean\
	pandas.core.window.rolling.Window.std\
	pandas.core.window.rolling.Window.sum\
	pandas.core.window.rolling.Window.var\
	pandas.plotting.bootstrap_plot\
	pandas.plotting.boxplot\
	pandas.plotting.radviz # There should be no backslash in the final line, please keep this comment in the last ignored function
	RET=$(($RET + $?)) ; echo $MSG "DONE"

Currently, some methods fail the SA05 check.

The task here is:

• take 2-4 methods
• run: scripts/validate_docstrings.py --format=actions --errors=SA05 method-name
• check if validation docstrings passes for those methods, and if it’s necessary fix the docstrings according to whatever error is reported
• remove those methods from code_checks.sh
• 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

[jordan-d-murphy]

I don't have permission to add them, but this could probably use some labels:

• CI
• Docs
• good first issue

[jordan-d-murphy]

Addresses #57352

[jordan-d-murphy]

I'll take

pandas.DataFrame.agg
pandas.DataFrame.aggregate
pandas.DataFrame.boxplot

[williamking1221]

I'll take

     pandas.PeriodIndex.asfreq
     pandas.arrays.ArrowStringArray
     pandas.arrays.StringArray

[Pistonamey]

I'll take
pandas.core.groupby.DataFrameGroupBy.first pandas.core.groupby.DataFrameGroupBy.last

[jordan-d-murphy]

I found a small fix that resolved all of the ExponentialMovingWindow, Expanding, Rolling, and Window SA05 errors (and pandas.plotting.boxplot).

This fix takes care of the following:

pandas.core.window.ewm.ExponentialMovingWindow.corr
pandas.core.window.ewm.ExponentialMovingWindow.cov
pandas.core.window.ewm.ExponentialMovingWindow.mean
pandas.core.window.ewm.ExponentialMovingWindow.std
pandas.core.window.ewm.ExponentialMovingWindow.sum
pandas.core.window.ewm.ExponentialMovingWindow.var

pandas.core.window.expanding.Expanding.apply
pandas.core.window.expanding.Expanding.corr
pandas.core.window.expanding.Expanding.count
pandas.core.window.expanding.Expanding.cov
pandas.core.window.expanding.Expanding.kurt
pandas.core.window.expanding.Expanding.max
pandas.core.window.expanding.Expanding.mean
pandas.core.window.expanding.Expanding.median
pandas.core.window.expanding.Expanding.min
pandas.core.window.expanding.Expanding.quantile
pandas.core.window.expanding.Expanding.rank
pandas.core.window.expanding.Expanding.sem
pandas.core.window.expanding.Expanding.skew
pandas.core.window.expanding.Expanding.std
pandas.core.window.expanding.Expanding.sum
pandas.core.window.expanding.Expanding.var

pandas.core.window.rolling.Rolling.apply
pandas.core.window.rolling.Rolling.corr
pandas.core.window.rolling.Rolling.count
pandas.core.window.rolling.Rolling.cov
pandas.core.window.rolling.Rolling.kurt
pandas.core.window.rolling.Rolling.max
pandas.core.window.rolling.Rolling.mean
pandas.core.window.rolling.Rolling.median
pandas.core.window.rolling.Rolling.min
pandas.core.window.rolling.Rolling.quantile
pandas.core.window.rolling.Rolling.rank
pandas.core.window.rolling.Rolling.sem
pandas.core.window.rolling.Rolling.skew
pandas.core.window.rolling.Rolling.std
pandas.core.window.rolling.Rolling.sum
pandas.core.window.rolling.Rolling.var

pandas.core.window.rolling.Window.mean
pandas.core.window.rolling.Window.std
pandas.core.window.rolling.Window.sum
pandas.core.window.rolling.Window.var

pandas.plotting.boxplot

[jordan-d-murphy]

I think this is the updated list of what's left:

        pandas.core.groupby.SeriesGroupBy.first
        pandas.core.groupby.SeriesGroupBy.last
        pandas.core.resample.Resampler.first
        pandas.core.resample.Resampler.last
        pandas.core.window.expanding.Expanding.aggregate
        pandas.core.window.rolling.Rolling.aggregate
        pandas.plotting.bootstrap_plot
        pandas.plotting.radviz

[Pistonamey]

Hey @jordan-d-murphy

I can take SeriesGroupBy : first and last once my previous PR gets merged.