pandas-dev / pandas

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more
https://pandas.pydata.org
BSD 3-Clause "New" or "Revised" License
43.4k stars 17.83k forks source link

DOC: TimeGrouper seems to be missing #54295

Open wjandrea opened 1 year ago

wjandrea commented 1 year ago

Pandas version checks

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.core.groupby.SeriesGroupBy.resample.html

https://pandas.pydata.org/docs/search.html?q=timegrouper

Related:

Documentation problem

I'm learning how to use resample and it says:

*`args, kwargs` Possible arguments are how, _fillmethod, limit, kind and on, and other arguments of TimeGrouper.

But I can't find where those parameters are documented. I thought TimeGrouper would have its own page in the documentation. If not, maybe it should be documented under Grouper? I'm not sure.

At least, it looks like the parameters are covered, at least in part, in the User Guide: Time series / date functionality

For reference, TimeGrouper is defined here on the current tip of main.

Suggested fix for documentation

I don't know, I just got here.

wjandrea commented 1 year ago

I just found out TimeGrouper was deprecated in 0.21 and removed in 0.25. But I guess it's sticking around only as an under-the-hood type, since it's been added to the Grouper docs on dev. (edit: I just saw jreback's comment confirming that)

And I just noticed I was looking at groupby-resample instead of plain resample. I'm not quite sure what the difference is, but the parameter documentation for plain resample seems to be much more thorough.