Skip to content

Commit f9f72d1

Browse files
DOC: fix SA01,ES01 for groups method of groupby and resampler (#60252)
1 parent f307a0a commit f9f72d1

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

ci/code_checks.sh

-3
Original file line numberDiff line numberDiff line change
@@ -92,22 +92,19 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9292
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
9393
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
9494
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
95-
-i "pandas.core.groupby.DataFrameGroupBy.groups SA01" \
9695
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
9796
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
9897
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
9998
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
10099
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
101100
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
102-
-i "pandas.core.groupby.SeriesGroupBy.groups SA01" \
103101
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
104102
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \
105103
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \
106104
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
107105
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
108106
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
109107
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
110-
-i "pandas.core.resample.Resampler.groups SA01" \
111108
-i "pandas.core.resample.Resampler.indices SA01" \
112109
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
113110
-i "pandas.core.resample.Resampler.mean SA01" \

pandas/core/groupby/groupby.py

+14
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,20 @@ def groups(self) -> dict[Hashable, Index]:
435435
"""
436436
Dict {group name -> group labels}.
437437
438+
This property provides a dictionary representation of the groupings formed
439+
during a groupby operation, where each key represents a unique group value from
440+
the specified column(s), and each value is a list of index labels
441+
that belong to that group.
442+
443+
See Also
444+
--------
445+
core.groupby.DataFrameGroupBy.get_group : Retrieve group from a
446+
``DataFrameGroupBy`` object with provided name.
447+
core.groupby.SeriesGroupBy.get_group : Retrieve group from a
448+
``SeriesGroupBy`` object with provided name.
449+
core.resample.Resampler.get_group : Retrieve group from a
450+
``Resampler`` object with provided name.
451+
438452
Examples
439453
--------
440454

0 commit comments

Comments
 (0)