Skip to content

DOC: groupby by argument types #48230

Closed
@amotzop

Description

@amotzop

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsNeeds TriageIssue that has not been reviewed by a pandas team member

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions