From 249a76f9b9e46a7966ff2eb3d4c48ffb6f2e4d8c Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Sun, 25 Feb 2024 02:28:09 -0700 Subject: [PATCH] fixing RT03 errors for pandas.DataFrame.expanding --- ci/code_checks.sh | 2 -- pandas/core/window/expanding.py | 5 +++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 47a2cf93a4f89..1b53a867f2a0f 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -445,7 +445,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.convert_dtypes\ pandas.DataFrame.corr\ pandas.DataFrame.droplevel\ - pandas.DataFrame.expanding\ pandas.DataFrame.explode\ pandas.DataFrame.ffill\ pandas.DataFrame.fillna\ @@ -1886,7 +1885,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.DataFrame.astype\ pandas.DataFrame.at_time\ pandas.DataFrame.ewm\ - pandas.DataFrame.expanding\ pandas.DataFrame.filter\ pandas.DataFrame.first_valid_index\ pandas.DataFrame.get\ diff --git a/pandas/core/window/expanding.py b/pandas/core/window/expanding.py index c3ee53c1b4551..abe853a8aa259 100644 --- a/pandas/core/window/expanding.py +++ b/pandas/core/window/expanding.py @@ -51,6 +51,9 @@ class Expanding(RollingAndExpandingMixin): """ Provide expanding window calculations. + An expanding window yields the value of an aggregation statistic with all the data + available up to that point in time. + Parameters ---------- min_periods : int, default 1 @@ -69,6 +72,8 @@ class Expanding(RollingAndExpandingMixin): Returns ------- pandas.api.typing.Expanding + An instance of Expanding for further expanding window calculations, + e.g. using the ``sum`` method. See Also --------