Skip to content

DOC: fix SA01,ES01 for pandas.core.groupby.DataFrameGroupBy.groups, pandas.core.groupby.SeriesGroupBy.groups and pandas.core.resample.Resampler.groups #60252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.arrays.TimedeltaArray PR07,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.boxplot PR07,RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.groups SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.indices SA01" \
-i "pandas.core.groupby.DataFrameGroupBy.nth PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.nunique SA01" \
Expand Down
12 changes: 12 additions & 0 deletions pandas/core/groupby/groupby.py
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,18 @@ def groups(self) -> dict[Hashable, Index]:
"""
Dict {group name -> group labels}.

This property provides a dictionary representation of the groupings formed
during a groupby operation, where each key represents a unique group value from
the specified column(s), and each value is a list of index of the row labels
that belong to that group.

See Also
--------
core.groupby.DataFrameGroupBy.get_group : Get a DataFrame or Series that
contains the rows belonging to the specified group.
core.groupby.DataFrameGroupBy.indices : Get a dict with group labels as keys
and lists of integer indices of rows in each group as values.

Examples
--------

Expand Down
Loading