-
-
Notifications
You must be signed in to change notification settings - Fork 18.1k
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
DOC: Update GroupBy docstrings with See Also requirements #59748
DOC: Update GroupBy docstrings with See Also requirements #59748
Conversation
pandas/core/groupby/groupby.py
Outdated
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why "group values" if you're linking to e.g. Series.min
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe just Series values
or DataFrame values
as appropriate?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rhshadrach let me know if this is appropriate or not.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Thanks @ktseng4096 |
This PR fixes docstring validation errors described in #58063