You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently we have documentation of various groupby methods on GroupBy for any methods of SeriesGroupBy and DataFrameGroupBy that share an implementation, on DataFrameGroupBy if they exist on both but do not share an implementation, or on SeriesGroupBy xor DataFrameGroupBy if they only exist on one. This can make locating the docs a bit tricky, and the documentation also contains the line:
The following methods are available in both SeriesGroupBy and DataFrameGroupBy objects, but may differ slightly, usually in that the DataFrameGroupBy version usually permits the specification of an axis argument, and often an argument indicating whether to restrict application to columns of a specific data type.
I think it would be better to generate docs for all SeriesGroupBy methods and all DataFrameGroupBy methods individually, even if they entirely overlap.
This is somewhat related to #6944, as I think it would be then possible to treat GroupBy as an internal pandas object (at least from a documentation perspective). But this isn't logically necessary.
I think it would be better to generate docs for all SeriesGroupBy methods and all DataFrameGroupBy methods individually, even if they entirely overlap.
+1 for this suggestion. Ideally users shouldn't really need to know of SeriesGroupBy and DataFrameGroupBy objects either, but it appears the most straightforward way to indicate whether Series or DataFrame supports a groupby method.
I was playing around with this a bit yesterday - I'm wondering what the best way to organize the documentation is. Two natural options, neither of which I personally love, but am finding I prefer the 2nd:
https://pandas.pydata.org/pandas-docs/dev/reference/groupby.html
Currently we have documentation of various groupby methods on
GroupBy
for any methods ofSeriesGroupBy
andDataFrameGroupBy
that share an implementation, onDataFrameGroupBy
if they exist on both but do not share an implementation, or onSeriesGroupBy
xorDataFrameGroupBy
if they only exist on one. This can make locating the docs a bit tricky, and the documentation also contains the line:I think it would be better to generate docs for all SeriesGroupBy methods and all DataFrameGroupBy methods individually, even if they entirely overlap.
This is somewhat related to #6944, as I think it would be then possible to treat
GroupBy
as an internal pandas object (at least from a documentation perspective). But this isn't logically necessary.cc @jorisvandenbossche
The text was updated successfully, but these errors were encountered: