DOC: fix SA05 errors in docstring for pandas.DataFrame - agg, aggrega…

…te, boxplot (pandas-dev#57404)
natmokval · Feb 13, 2024 · 8a77977 · 8a77977
1 parent 3475d83
commit 8a77977
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 9 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -143,9 +143,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
 
     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\

diff --git a/pandas/core/frame.py b/pandas/core/frame.py
@@ -9752,11 +9752,11 @@ def _gotitem(
     --------
     DataFrame.apply : Perform any type of operations.
     DataFrame.transform : Perform transformation type operations.
-    pandas.DataFrame.groupby : Perform operations over groups.
-    pandas.DataFrame.resample : Perform operations over resampled bins.
-    pandas.DataFrame.rolling : Perform operations over rolling window.
-    pandas.DataFrame.expanding : Perform operations over expanding window.
-    pandas.core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
+    DataFrame.groupby : Perform operations over groups.
+    DataFrame.resample : Perform operations over resampled bins.
+    DataFrame.rolling : Perform operations over rolling window.
+    DataFrame.expanding : Perform operations over expanding window.
+    core.window.ewm.ExponentialMovingWindow : Perform operation over exponential
         weighted window.
     """
     )

diff --git a/pandas/plotting/_core.py b/pandas/plotting/_core.py
@@ -335,7 +335,7 @@ def hist_frame(
 
 See Also
 --------
-pandas.Series.plot.hist: Make a histogram.
+Series.plot.hist: Make a histogram.
 matplotlib.pyplot.boxplot : Matplotlib equivalent plot.
 
 Notes