Skip to content

DOC: groupby by argument types #48230

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

Closed
1 task done
amotzop opened this issue Aug 24, 2022 · 2 comments · Fixed by #48357
Closed
1 task done

DOC: groupby by argument types #48230

amotzop opened this issue Aug 24, 2022 · 2 comments · Fixed by #48357
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member

Comments

@amotzop
Copy link
Contributor

amotzop commented Aug 24, 2022

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.DataFrame.groupby.html
https://pandas.pydata.org/docs/dev/reference/api/pandas.Series.groupby.html

Documentation problem

I think there are a couple of possible types for the by parameter of the groupby functions that are missing from the documentation:

  • pd.Grouper (as seen in the documentation of Grouper)
  • list of functions/list of mappings.

Suggested fix for documentation

Just add these types to the possible typings:
by: mapping, function, label, pd.Grouper or list of such

@amotzop amotzop added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Aug 24, 2022
@paradox-lab
Copy link
Contributor

I would like to take this.

@amotzop
Copy link
Contributor Author

amotzop commented Sep 2, 2022

Is there a reason the updated typing doesn't contain list of functions/mapping/pd.Grouper? From the code it seems to be supported?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Needs Triage Issue that has not been reviewed by a pandas team member
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants