Skip to content

Commit b10f692

Browse files
DOC: fix SA01,ES01 for pandas.core.groupby.DataFrameGroupBy.groups
1 parent 754d091 commit b10f692

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9696
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
9797
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
9898
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
99-
-i "pandas.core.groupby.DataFrameGroupBy.groups SA01" \
10099
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
101100
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
102101
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \

pandas/core/groupby/groupby.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,18 @@ 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 of the row labels
441+
that belong to that group.
442+
443+
See Also
444+
--------
445+
core.groupby.DataFrameGroupBy.get_group : Get a DataFrame or Series that
446+
contains the rows belonging to the specified group.
447+
core.groupby.DataFrameGroupBy.indices : Get a dict with group labels as keys
448+
and lists of integer indices of rows in each group as values.
449+
438450
Examples
439451
--------
440452

0 commit comments

Comments
 (0)