-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Include SeriesGroupBy ops in API docs #48399
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
Comments
+1 for this suggestion. Ideally users shouldn't really need to know of |
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:
vs
Another option I considered was a table with two column - DataFrameGroupBy and SeriesGroupBy - but I think this doesn't work with autosummary. |
The second looks better to me also IMO |
Uh oh!
There was an error while loading. Please reload this page.
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: