Skip to content

Commit b231891

Browse files
jordan-d-murphypmhatre1
authored andcommitted
DOC: fix SA05 errors in docstring for pandas.DataFrame - agg, aggregate, boxplot (pandas-dev#57404)
1 parent 0ab847b commit b231891

File tree

3 files changed

+6
-9
lines changed

3 files changed

+6
-9
lines changed

ci/code_checks.sh

-3
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
143143

144144
MSG='Partially validate docstrings (SA05)' ; echo $MSG
145145
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=SA05 --ignore_functions \
146-
pandas.DataFrame.agg\
147-
pandas.DataFrame.aggregate\
148-
pandas.DataFrame.boxplot\
149146
pandas.PeriodIndex.asfreq\
150147
pandas.arrays.ArrowStringArray\
151148
pandas.arrays.StringArray\

pandas/core/frame.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -9752,11 +9752,11 @@ def _gotitem(
97529752
--------
97539753
DataFrame.apply : Perform any type of operations.
97549754
DataFrame.transform : Perform transformation type operations.
9755-
pandas.DataFrame.groupby : Perform operations over groups.
9756-
pandas.DataFrame.resample : Perform operations over resampled bins.
9757-
pandas.DataFrame.rolling : Perform operations over rolling window.
9758-
pandas.DataFrame.expanding : Perform operations over expanding window.
9759-
pandas.core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
9755+
DataFrame.groupby : Perform operations over groups.
9756+
DataFrame.resample : Perform operations over resampled bins.
9757+
DataFrame.rolling : Perform operations over rolling window.
9758+
DataFrame.expanding : Perform operations over expanding window.
9759+
core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
97609760
weighted window.
97619761
"""
97629762
)

pandas/plotting/_core.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ def hist_frame(
335335
336336
See Also
337337
--------
338-
pandas.Series.plot.hist: Make a histogram.
338+
Series.plot.hist: Make a histogram.
339339
matplotlib.pyplot.boxplot : Matplotlib equivalent plot.
340340
341341
Notes

0 commit comments

Comments
 (0)