DOC: Add User Guide links to GroupBy aggregate, transform, and apply methods #63837
+14
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…methods Add cross-references to the User Guide in the See Also sections of: - SeriesGroupBy.aggregate - DataFrameGroupBy.aggregate - transform (via _transform_template) - GroupBy.apply This helps users discover the relevant User Guide sections when using the API reference. Closes pandas-dev#62357
Move :ref: directives from See Also section to Notes section because numpydoc does not support :ref: in See Also entries.
rhshadrach
requested changes
Jan 24, 2026
pandas/core/groupby/groupby.py
Outdated
| Notes | ||
| ----- | ||
| See :ref:`groupby.transform` in the User Guide for more details and examples. |
Member
There was a problem hiding this comment.
This transform template appears no longer used. Can you update the two methods transform in generic.py.
Member
There was a problem hiding this comment.
Can also remove this template I think; but that can also be done in a separate PR.
Author
There was a problem hiding this comment.
sure, Thanks for letting me know
| Notes | ||
| ----- | ||
| See :ref:`groupby.apply` in the User Guide for more details and examples. |
Member
There was a problem hiding this comment.
Can you also add this line to SeriesGroupBy.apply in generic.py.
- Remove link from _transform_template (no longer used) - Add link to SeriesGroupBy.apply - Add link to SeriesGroupBy.transform - Add link to DataFrameGroupBy.transform
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds cross-references from the GroupBy API documentation back to the User Guide, addressing #62357.
Changes
Added
:ref:links to the User Guide in theSee Alsosections of:SeriesGroupBy.aggregategroupby.aggregateDataFrameGroupBy.aggregategroupby.aggregatetransform(via_transform_template)groupby.transformGroupBy.applygroupby.applyAlso added a note in the API reference (
doc/source/reference/groupby.rst) with links to relevant User Guide sections.Motivation
As noted in the issue, users navigating from the User Guide to API docs couldn't easily navigate back. This improves discoverability of the comprehensive User Guide sections on groupby operations.
Files Changed
pandas/core/groupby/generic.py- Added User Guide links to aggregate docstringspandas/core/groupby/groupby.py- Added User Guide links to apply and transform docstringsdoc/source/reference/groupby.rst- Added User Guide references in Function application sectionCloses #62357