DOC: Resolve SA05 errors for all ExponentialMovingWindow, Expanding, …

…Rolling, and Window (#57415)
pandas-dev · Feb 14, 2024 · e2fc924 · e2fc924
1 parent 44c50b2
commit e2fc924
Show file tree

Hide file tree

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

diff --git a/pandas/core/window/doc.py b/pandas/core/window/doc.py
@@ -24,10 +24,10 @@ def create_section_header(header: str) -> str:
 
 template_see_also = dedent(
     """
-    pandas.Series.{window_method} : Calling {window_method} with Series data.
-    pandas.DataFrame.{window_method} : Calling {window_method} with DataFrames.
-    pandas.Series.{agg_method} : Aggregating {agg_method} for Series.
-    pandas.DataFrame.{agg_method} : Aggregating {agg_method} for DataFrame.\n
+    Series.{window_method} : Calling {window_method} with Series data.
+    DataFrame.{window_method} : Calling {window_method} with DataFrames.
+    Series.{agg_method} : Aggregating {agg_method} for Series.
+    DataFrame.{agg_method} : Aggregating {agg_method} for DataFrame.\n
     """
 ).replace("\n", "", 1)