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: Added docstring to Timestamp.tzinfo #61134

Closed
wants to merge 3 commits into from

Conversation

j-hendricks
Copy link
Contributor

Follow up on #59458

Added docstring to Timestamp.tzinfo. Emphasized that Timestamp.tz is preferred due to its Pandas-specific functionality. Sections added are as follows:

  • Summary
  • Extended Summary
  • See Also
  • Examples

Removed Timestamp.tzinfo from code_checks.sh

Comment on lines +2985 to +2986
For pandas-specific timezone operations, the `tz` property is the
recommended interface.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessarily true. Could you remove this statement?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know! I just assumed that tz was preferred because it already had a docstring but tzinfo didn't. I will remove

@mroeschke mroeschke added the Docs label Mar 17, 2025
@mroeschke
Copy link
Member

Sorry, it appears a contributor already opened a PR a few days ago to address this issue in #61100 that was merged.

Closing this PR as solved, but happy to have more PRs!

@mroeschke mroeschke closed this Mar 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: fix docstring validation errors for pandas.Timestamp
3 participants