DOC: DataFrame.groupby() includes no mention of some important functionality

[tobiasmcnulty]

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

Location of the documentation

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

Documentation problem

The reference for DataFrame.groupby is absent of any reference to iterating through groups, which seems like a fairly critical piece of information (I ended up brewing my own solution, before eventually finding the user guide link). A link to the user guide is included, but it's easy to miss.

Suggested fix for documentation

The documentation could be improved by including some suggestions of what one might find in the user guide. For example, the text "See the user guide for more." could be replaced with something like the following:

See the user guide for detailed usage and examples, including splitting an object into groups, iterating through groups, selecting a group, aggregation, and more.

[mzeitlin11]

Thanks for reporting this @tobiasmcnulty! Agreed that your suggestion would be an improvement, would you be interested in making a pr?

[tobiasmcnulty]

Happy to! Though I'm struggling to find where this is in the repo, if someone could possibly point me in the right direction...

[mzeitlin11]

Happy to! Though I'm struggling to find where this is in the repo, if someone could possibly point me in the right direction...

This one is hard to find :) I think it's at pandas/core/shared_docs.py, around L140