Skip to content

DOC: Add User Guide links to GroupBy aggregate, transform, and apply methods #63837

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

Open
chaitanyakumar-d wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −0
Open

DOC: Add User Guide links to GroupBy aggregate, transform, and apply methods #63837

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f81dd91
DOC: Add User Guide links to GroupBy aggregate, transform, and apply …
chaitanyakumar-d Jan 23, 2026
efdb741
DOC: Fix User Guide references - move from See Also to Notes
chaitanyakumar-d Jan 23, 2026
ba7da4e
Address review comments: move User Guide links to correct methods
chaitanyakumar-d Jan 24, 2026
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
6 changes: 6 additions & 0 deletions pandas/core/groupby/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,9 @@ def aggregate(self, func=None, *args, engine=None, engine_kwargs=None, **kwargs)

Notes
-----
See :ref:`groupby.aggregate` in the User Guide for more details
and examples.

When using ``engine='numba'``, there will be no "fall back" behavior internally.
The group data and group index will be passed as numpy arrays to the JITed
user defined function, and no alternative execution attempts will be tried.
Expand Down Expand Up @@ -2180,6 +2183,9 @@ def aggregate(self, func=None, *args, engine=None, engine_kwargs=None, **kwargs)

Notes
-----
See :ref:`groupby.aggregate` in the User Guide for more details
and examples.

When using ``engine='numba'``, there will be no "fall back" behavior internally.
The group data and group index will be passed as numpy arrays to the JITed
user defined function, and no alternative execution attempts will be tried.
Expand Down
4 changes: 4 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 @@ -375,6 +375,8 @@ class providing the base-class of operations.

Notes
-----
See :ref:`groupby.transform` in the User Guide for more details and examples.
Copy link
Member

@rhshadrach rhshadrach Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This transform template appears no longer used. Can you update the two methods transform in generic.py.

Copy link
Member

@rhshadrach rhshadrach Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can also remove this template I think; but that can also be done in a separate PR.

Copy link
Author

@chaitanyakumar-d chaitanyakumar-d Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure, Thanks for letting me know


Each group is endowed the attribute 'name' in case you need to know
which group you are working on.

Expand Down Expand Up @@ -1541,6 +1543,8 @@ def apply(self, func, *args, include_groups: bool = False, **kwargs) -> NDFrameT

Notes
-----
See :ref:`groupby.apply` in the User Guide for more details and examples.
Copy link
Member

@rhshadrach rhshadrach Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add this line to SeriesGroupBy.apply in generic.py.


The resulting dtype will reflect the return value of the passed ``func``,
see the examples below.

Expand Down
Loading