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.

Sign up for GitHub

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
merged 4 commits into from
Nov 11, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b10f692
DOC: fix SA01,ES01 for pandas.core.groupby.DataFrameGroupBy.groups
tuhinsharma121 Nov 8, 2024
38bfe3b
Update pandas/core/groupby/groupby.py
tuhinsharma121 Nov 10, 2024
5135fae
Merge branch 'main' into pandas.core.groupby.DataFrameGroupBy.groups
tuhinsharma121 Nov 10, 2024
9890c70
DOC: fix SA01,ES01 for pandas.core.groupby.DataFrameGroupBy.groups
tuhinsharma121 Nov 10, 2024
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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,22 +94,19 @@ 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" \
-i "pandas.core.groupby.DataFrameGroupBy.plot PR02" \
-i "pandas.core.groupby.DataFrameGroupBy.sem SA01" \
-i "pandas.core.groupby.SeriesGroupBy.get_group RT03,SA01" \
-i "pandas.core.groupby.SeriesGroupBy.groups SA01" \
-i "pandas.core.groupby.SeriesGroupBy.indices SA01" \
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_decreasing SA01" \
-i "pandas.core.groupby.SeriesGroupBy.is_monotonic_increasing SA01" \
-i "pandas.core.groupby.SeriesGroupBy.nth PR02" \
-i "pandas.core.groupby.SeriesGroupBy.plot PR02" \
-i "pandas.core.groupby.SeriesGroupBy.sem SA01" \
-i "pandas.core.resample.Resampler.get_group RT03,SA01" \
-i "pandas.core.resample.Resampler.groups SA01" \
-i "pandas.core.resample.Resampler.indices SA01" \
-i "pandas.core.resample.Resampler.max PR01,RT03,SA01" \
-i "pandas.core.resample.Resampler.mean SA01" \
Expand Down
14 changes: 14 additions & 0 deletions pandas/core/groupby/groupby.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,20 @@ 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 labels
that belong to that group.

See Also
--------
core.groupby.DataFrameGroupBy.get_group : Retrieve group from a
``DataFrameGroupBy`` object with provided name.
core.groupby.SeriesGroupBy.get_group : Retrieve group from a
``SeriesGroupBy`` object with provided name.
core.resample.Resampler.get_group : Retrieve group from a
``Resampler`` object with provided name.

Examples
--------

Expand Down
Loading