Skip to content
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

DOC: TimeGrouper seems to be missing #54295

Open
1 task done
wjandrea opened this issue Jul 28, 2023 · 1 comment
Open
1 task done

DOC: TimeGrouper seems to be missing #54295

wjandrea opened this issue Jul 28, 2023 · 1 comment
Labels
Docs Resample resample method

Comments

@wjandrea
Copy link
Contributor

wjandrea commented Jul 28, 2023

Pandas version checks

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

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, fill_method, 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 wjandrea added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 28, 2023
@wjandrea
Copy link
Contributor Author

wjandrea commented Jul 28, 2023

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.

@mroeschke mroeschke added Resample resample method and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Resample resample method
Projects
None yet
Development

No branches or pull requests

2 participants