Skip to content

Commit 5927bd8

Browse files
authored
DOC: Update GroupBy docstrings with See Also requirements (#59748)
* update groupby docstrings * fix function name
1 parent 2a3cf83 commit 5927bd8

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

ci/code_checks.sh

-6
Original file line numberDiff line numberDiff line change
@@ -153,14 +153,11 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
153153
-i "pandas.core.groupby.DataFrameGroupBy.groups SA01" \
154154
-i "pandas.core.groupby.DataFrameGroupBy.hist RT03" \
155155
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
156-
-i "pandas.core.groupby.DataFrameGroupBy.max SA01" \
157-
-i "pandas.core.groupby.DataFrameGroupBy.min SA01" \
158156
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
159157
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
160158
-i "pandas.core.groupby.DataFrameGroupBy.ohlc SA01" \
161159
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
162160
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
163-
-i "pandas.core.groupby.DataFrameGroupBy.sum SA01" \
164161
-i "pandas.core.groupby.SeriesGroupBy.__iter__ RT03,SA01" \
165162
-i "pandas.core.groupby.SeriesGroupBy.agg RT03" \
166163
-i "pandas.core.groupby.SeriesGroupBy.aggregate RT03" \
@@ -169,13 +166,10 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
169166
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
170167
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \
171168
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \
172-
-i "pandas.core.groupby.SeriesGroupBy.max SA01" \
173-
-i "pandas.core.groupby.SeriesGroupBy.min SA01" \
174169
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
175170
-i "pandas.core.groupby.SeriesGroupBy.ohlc SA01" \
176171
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
177172
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
178-
-i "pandas.core.groupby.SeriesGroupBy.sum SA01" \
179173
-i "pandas.core.resample.Resampler.__iter__ RT03,SA01" \
180174
-i "pandas.core.resample.Resampler.ffill RT03" \
181175
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \

pandas/core/groupby/generic.py

+2
Original file line numberDiff line numberDiff line change
@@ -615,6 +615,7 @@ def filter(self, func, dropna: bool = True, *args, **kwargs):
615615
616616
See Also
617617
--------
618+
Series.filter: Filter elements of ungrouped Series.
618619
DataFrameGroupBy.filter : Filter elements from groups base on criterion.
619620
620621
Notes
@@ -1963,6 +1964,7 @@ def filter(self, func, dropna: bool = True, *args, **kwargs) -> DataFrame:
19631964
19641965
See Also
19651966
--------
1967+
DataFrame.filter: Filter elements of ungrouped DataFrame.
19661968
SeriesGroupBy.filter : Filter elements from groups base on criterion.
19671969
19681970
Notes

pandas/core/groupby/groupby.py

+9
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,15 @@ class providing the base-class of operations.
199199
Series or DataFrame
200200
Computed {fname} of values within each group.
201201
202+
See Also
203+
--------
204+
SeriesGroupBy.min : Return the min of the group values.
205+
DataFrameGroupBy.min : Return the min of the group values.
206+
SeriesGroupBy.max : Return the max of the group values.
207+
DataFrameGroupBy.max : Return the max of the group values.
208+
SeriesGroupBy.sum : Return the sum of the group values.
209+
DataFrameGroupBy.sum : Return the sum of the group values.
210+
202211
Examples
203212
--------
204213
{example}

0 commit comments

Comments
 (0)