From 0a6867796ed7bbc827e8cd94c496f4d001724e77 Mon Sep 17 00:00:00 2001 From: Sukriti Bhardwaj Date: Sun, 28 Jul 2024 14:38:31 -0400 Subject: [PATCH 1/3] Fix docstring SA01 error for pandas.core.groupby median --- ci/code_checks.sh | 2 -- pandas/core/groupby/groupby.py | 5 +++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 1e9250fd77fe5..182f712508bbd 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -330,7 +330,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.core.groupby.DataFrameGroupBy.hist RT03" \ -i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \ -i "pandas.core.groupby.DataFrameGroupBy.max SA01" \ - -i "pandas.core.groupby.DataFrameGroupBy.median SA01" \ -i "pandas.core.groupby.DataFrameGroupBy.min SA01" \ -i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \ -i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \ @@ -349,7 +348,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \ -i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \ -i "pandas.core.groupby.SeriesGroupBy.max SA01" \ - -i "pandas.core.groupby.SeriesGroupBy.median SA01" \ -i "pandas.core.groupby.SeriesGroupBy.min SA01" \ -i "pandas.core.groupby.SeriesGroupBy.nth PR02" \ -i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \ diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index bf71bb80b3623..bfb84bec55332 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -2338,6 +2338,11 @@ def median(self, numeric_only: bool = False) -> NDFrameT: Series or DataFrame Median of values within each group. + See Also + -------- + Series.groupby : Apply a function groupby to a Series. + DataFrame.groupby : Apply a function groupby to each row or column of a DataFrame. + Examples -------- For SeriesGroupBy: From cb21950178a01bbc430bb960b081aa1f68ae41d9 Mon Sep 17 00:00:00 2001 From: Sukriti Bhardwaj Date: Sun, 28 Jul 2024 21:12:20 -0400 Subject: [PATCH 2/3] fix SA01 docstring code check for pandas core resample median --- ci/code_checks.sh | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 182f712508bbd..a6148b0314218 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -362,7 +362,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then -i "pandas.core.resample.Resampler.indices SA01" \ -i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \ -i "pandas.core.resample.Resampler.mean SA01" \ - -i "pandas.core.resample.Resampler.median SA01" \ -i "pandas.core.resample.Resampler.min PR01,RT03,SA01" \ -i "pandas.core.resample.Resampler.ohlc SA01" \ -i "pandas.core.resample.Resampler.prod SA01" \ From 4a38a744ba1e8e4690cac4c5d9b6c6316389cb74 Mon Sep 17 00:00:00 2001 From: Sukriti Bhardwaj Date: Sun, 28 Jul 2024 21:18:12 -0400 Subject: [PATCH 3/3] fix E501 docstring for pandas core groupby median --- pandas/core/groupby/groupby.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pandas/core/groupby/groupby.py b/pandas/core/groupby/groupby.py index bfb84bec55332..4c8b8dcc35387 100644 --- a/pandas/core/groupby/groupby.py +++ b/pandas/core/groupby/groupby.py @@ -2341,7 +2341,8 @@ def median(self, numeric_only: bool = False) -> NDFrameT: See Also -------- Series.groupby : Apply a function groupby to a Series. - DataFrame.groupby : Apply a function groupby to each row or column of a DataFrame. + DataFrame.groupby : Apply a function groupby to each row or column of a + DataFrame. Examples --------