Skip to content

DOC: tz_convert docs could be improved for Series and DataFrame #47129

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 task done
jackgoldsmith4 opened this issue May 26, 2022 · 1 comment · Fixed by #47131
Closed
1 task done

DOC: tz_convert docs could be improved for Series and DataFrame #47129

jackgoldsmith4 opened this issue May 26, 2022 · 1 comment · Fixed by #47131
Labels
Docs Timezones Timezone data dtype

Comments

@jackgoldsmith4
Copy link
Contributor

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.Series.tz_convert.html

Documentation problem

The documentation for this function lacks examples and returns {klass} instead of "Series or DataFrame"

Suggested fix for documentation

Add examples for this function and fix the Returns section
@jackgoldsmith4 jackgoldsmith4 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels May 26, 2022
@mroeschke mroeschke added Timezones Timezone data dtype and removed Needs Triage Issue that has not been reviewed by a pandas team member labels May 26, 2022
@mroeschke
Copy link
Member

Looks like the {klass} parameterization wasn't filled in correctly. A PR to fix would be welcome!

@jackgoldsmith4 jackgoldsmith4 mentioned this issue May 26, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs Timezones Timezone data dtype
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix typo in tz_convert docs jackgoldsmith4/pandas
2 participants
@mroeschke @jackgoldsmith4