Skip to content

DOC: indicate that origin argument can be a string that is timestamp convertible #56877

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

Closed
1 task done
Dr-Irv opened this issue Jan 14, 2024 · 2 comments · Fixed by #56925
Closed
1 task done

DOC: indicate that origin argument can be a string that is timestamp convertible #56877

Dr-Irv opened this issue Jan 14, 2024 · 2 comments · Fixed by #56925
Assignees

Comments

@Dr-Irv
Copy link
Contributor

Dr-Irv commented Jan 14, 2024

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/dev/reference/api/pandas.DataFrame.resample.html

Documentation problem

The value origin is documented as:

The timestamp on which to adjust the grouping. The timezone of origin must match the timezone of the index. If string, must be one of the following:

with a list of acceptable strings.

But any timestamp-convertible string is acceptable, so that should be indicated in the docs.

Suggested fix for documentation

    origin : Timestamp or str, default 'start_day'
        The timestamp on which to adjust the grouping. The timezone of origin
        must match the timezone of the index.
        If string, must be Timestamp convertible or one of the following:
@Dr-Irv Dr-Irv added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 14, 2024
@Dr-Irv Dr-Irv changed the title DOC: indicate that origin s DOC: indicate that origin argument can be a string that is timestamp convertible Jan 14, 2024
@rhshadrach rhshadrach added Resample resample method good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Jan 16, 2024
@manlattan
Copy link
Contributor

@Dr-Irv If the issue is still open, I am ready to resolve the issue.

@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Jan 16, 2024

@Dr-Irv If the issue is still open, I am ready to resolve the issue.

I've assigned it to you

mroeschke pushed a commit that referenced this issue Jan 17, 2024
#56925)

DOC: indicate that origin argument can be a string that is timestamp convertible #56877
pmhatre1 pushed a commit to pmhatre1/pandas-pmhatre1 that referenced this issue May 7, 2024
pandas-dev#56925)

DOC: indicate that origin argument can be a string that is timestamp convertible pandas-dev#56877
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants