DOC: SeriesGroupby/DataFrameGroupBy is missing class documentaion from doc index

[allComputableThings]

Problem description

https://pandas-docs.github.io/pandas-docs-travis/generated/pandas.Grouper.html#pandas.Grouper

There are many references to the GroupBy class in the index -- but there is no class interface documentation listed in the index.

We have, for example "Categorical (class in pandas)", but not "GroupBy (class in pandas)"
which would let us know which methods are available in GroupBy.

[jreback]

GroupBy is not a public class. not sure what you are expecting here.

[TomAugspurger]

@stuz5000 can you clarify, are you interested in API docs for the object you get back from DataFrame.groupby? We have an internal class pandas.core.GroupBy, but users see either DataFrameGroupBy or SeriesGroupBy:

In [7]: df = pd.DataFrame({"A": range(10)})

In [8]: gr = df.groupby("A")

In [9]: type(gr)
Out[9]: pandas.core.groupby.DataFrameGroupBy

It'll take a bit of work before DataFrameGroupBy can be included in the API docs I think.

[allComputableThings]

I misunderstood. I thought GroupBy was the response of groupby. If this is an internal API, it shouldn't by referenced in the index (which is how I found it)? My issue is that I have no way to what methods are available on the result of group by. Is sortXXX available? No way to know without a trip to stackoverflow. Neither have class documentation though.

…

On Thu, Jan 18, 2018 at 6:56 PM Tom Augspurger ***@***.***> wrote: @stuz5000 <https://github.com/stuz5000> can you clarify, are you interested in API docs for the object you get back from DataFrame.groupby? We have an internal class pandas.core.GroupBy, but users see either DataFrameGroupBy or SeriesGroupBy: In [7]: df = pd.DataFrame({"A": range(10)}) In [8]: gr = df.groupby("A") In [9]: type(gr) Out[9]: pandas.core.groupby.DataFrameGroupBy It'll take a bit of work before DataFrameGroupBy can be included in the API docs I think. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#19302 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AHcErJLlm3OB8bY20w6B-o7DrkO7o0GMks5tMAR2gaJpZM4RjTzh> .

[jorisvandenbossche]

We currently list methods of GroupBy in the API docs: http://pandas.pydata.org/pandas-docs/stable/api.html#groupby
And I think it can be useful to document the class that you get back from groupby. This is indeed SeriesGroupby or DataFrameGroupBy, but we could also document GroupBy for both of them together (as we do for other generic methods of them).

Anyhow, their docstring (all three share the same one) would indeed need some work to be ready to included (now it explains things that are internal).

My issue is that I have no way to what methods are available on the result of group by. Is sortXXX available? No way to know without a trip to stackoverflow.

You can already check what is listed here: http://pandas.pydata.org/pandas-docs/stable/api.html#groupby (or use tab completion on the return object)

[allComputableThings]

@jorisvandenbossche Thanks - this page is extremely useful.

I didn't understand the distinction because the docs for DataFrame.groupby says it returns a GroupBy not a DataFrameGroupBy, so that's where I went hunting.

Its very hard to understand what you can do with a DataFrame.groupby() by following the docs for that method. It would help to show in the DataFrame.groupby page what concrete classes may be returned and have links to the class-level docs for these from there (and in the index: "DataFrameGroupBy class in pandas" "SeriesGroupBy class in pandas").

I've updated the title.

[jreback]

we have a master list of these needed docs in #6944