From 8a779779f1da24cb6ba7a49c40fcc855cb5b0b81 Mon Sep 17 00:00:00 2001 From: Jordan Murphy <35613487+jordan-d-murphy@users.noreply.github.com> Date: Tue, 13 Feb 2024 12:56:33 -0700 Subject: [PATCH] DOC: fix SA05 errors in docstring for pandas.DataFrame - agg, aggregate, boxplot (#57404) --- ci/code_checks.sh | 3 --- pandas/core/frame.py | 10 +++++----- pandas/plotting/_core.py | 2 +- 3 files changed, 6 insertions(+), 9 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 39ccf904858d5..d3a79779bb369 100755 --- 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 index 76c5549fc8f86..927518b766cc2 100644 --- 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 index 941022389c00a..edd619c264c7a 100644 --- 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