DOC: fix PR02 errors in docstrings - pandas.core.window.rolling.Rolli…

…ng.quantile, pandas.core.window.expanding.Expanding.quantile (pandas-dev#57211)
pmhatre1 · May 7, 2024 · 166fab7 · 166fab7
1 parent c656aa9
commit 166fab7
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -176,9 +176,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         pandas.core.groupby.DataFrameGroupBy.hist\
         pandas.core.groupby.DataFrameGroupBy.plot\
         pandas.core.groupby.DataFrameGroupBy.corrwith\
-        pandas.core.groupby.SeriesGroupBy.plot\
-        pandas.core.window.rolling.Rolling.quantile\
-        pandas.core.window.expanding.Expanding.quantile # There should be no backslash in the final line, please keep this comment in the last ignored function
+        pandas.core.groupby.SeriesGroupBy.plot # There should be no backslash in the final line, please keep this comment in the last ignored function
     RET=$(($RET + $?)) ; echo $MSG "DONE"
 
 fi

diff --git a/pandas/core/window/expanding.py b/pandas/core/window/expanding.py
@@ -664,11 +664,11 @@ def kurt(self, numeric_only: bool = False):
         create_section_header("Parameters"),
         dedent(
             """
-        quantile : float
+        q : float
             Quantile to compute. 0 <= quantile <= 1.
 
             .. deprecated:: 2.1.0
-                This will be renamed to 'q' in a future version.
+                This was renamed from 'quantile' to 'q' in version 2.1.0.
         interpolation : {{'linear', 'lower', 'higher', 'midpoint', 'nearest'}}
             This optional parameter specifies the interpolation method to use,
             when the desired quantile lies between two data points `i` and `j`:

diff --git a/pandas/core/window/rolling.py b/pandas/core/window/rolling.py
@@ -2502,11 +2502,11 @@ def kurt(self, numeric_only: bool = False):
         create_section_header("Parameters"),
         dedent(
             """
-        quantile : float
+        q : float
             Quantile to compute. 0 <= quantile <= 1.
 
             .. deprecated:: 2.1.0
-                This will be renamed to 'q' in a future version.
+                This was renamed from 'quantile' to 'q' in version 2.1.0.
         interpolation : {{'linear', 'lower', 'higher', 'midpoint', 'nearest'}}
             This optional parameter specifies the interpolation method to use,
             when the desired quantile lies between two data points `i` and `j`: