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: Document attributes of Timedelta #59698 #60171

Closed
wants to merge 1 commit into from

Conversation

ammar-qazi
Copy link
Contributor

Part of #59698

Addresses:

pandas.Timedelta

Added the missing explanations (PRO2) for min, max, and resolution.

Removed:

i "pandas.Timedelta.resolution PR02" \
i "pandas.Timedelta.min PR02" \
i "pandas.Timedelta.resolution PR02" \

from code_checks.sh

Copy link
Member

@rhshadrach rhshadrach left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@@ -1893,6 +1893,21 @@ class Timedelta(_Timedelta):
Values for construction in compat with datetime.timedelta.
Numpy ints and floats will be coerced to python ints and floats.

Attributes
----------
resolution: Timedelta
Copy link
Member

Choose a reason for hiding this comment

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

Nit: resolution : Timedelta

resolution: Timedelta
Represents the smallest difference between two time units that can be
represented by the Timedelta object.
Fixed at 0 days 00:00:00.000000001 (1 nanosecond).
Copy link
Member

Choose a reason for hiding this comment

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

I think this is an example? I'd suggest removing this - we don't give examples in the attribute descriptions and it doesn't seem necessary.

Same applies to the two attributes below.

@rhshadrach rhshadrach added Docs Timedelta Timedelta data type labels Nov 6, 2024
@rhshadrach rhshadrach changed the title Fix part of docstring Timedelta #59698 DOC: Document attributes of Timedelta #59698 Nov 6, 2024
@mroeschke
Copy link
Member

Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.

@mroeschke mroeschke closed this Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Timedelta Timedelta data type
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants