From 166fab76bdc9b980b359626c9d4cc60b371ee5ca Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Fri, 2 Feb 2024 04:59:13 -0700 Subject: [PATCH] DOC: fix PR02 errors in docstrings - pandas.core.window.rolling.Rolling.quantile, pandas.core.window.expanding.Expanding.quantile (#57211) --- ci/code_checks.sh | 4 +--- pandas/core/window/expanding.py | 4 ++-- pandas/core/window/rolling.py | 4 ++-- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 9e1239c72776e..a09c4662a1fd9 100755 --- 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 index 1bf26c482337c..c048c4a506629 100644 --- 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 index 72a61b2877809..b55432085b928 100644 --- 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`: