DOC: Update GroupBy docstrings with See Also requirements #59748
Conversation
This file contains 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
rhshadrach
reviewed
Sep 8, 2024
pandas/core/groupby/groupby.py
Outdated
Comment on lines
204
to
209
| Series.min : Return the min of the group values. | ||
| DataFrame.min : Return the min of the group values. | ||
| Series.max : Return the max of the group values. | ||
| DataFrame.max : Return the max of the group values. | ||
| Series.sum : Return the sum of the group values. | ||
| DataFrame.sum : Return the sum of the group values. |
There was a problem hiding this comment.
Why "group values" if you're linking to e.g. Series.min?
There was a problem hiding this comment.
Maybe just Series values or DataFrame values as appropriate?
There was a problem hiding this comment.
Thanks for catching that, I referenced the wrong function, should have been the groupby versions of those functions.
I saw elsewhere that a different template had all the functions that used the template in the see also section so I went with that same approach.
There was a problem hiding this comment.
@rhshadrach let me know if this is appropriate or not.
mroeschke
approved these changes
Sep 12, 2024
|
Thanks @ktseng4096 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR fixes docstring validation errors described in #58063