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.

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

DOC: Document attributes of Timedelta #59698 #60171

Closed
wants to merge 1 commit into from
Closed

DOC: Document attributes of Timedelta #59698 #60171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.freq GL08" \
-i "pandas.Series.dt.unit GL08" \
-i "pandas.Series.pad PR01,SA01" \
-i "pandas.Timedelta.max PR02" \
-i "pandas.Timedelta.min PR02" \
-i "pandas.Timedelta.resolution PR02" \
-i "pandas.Timestamp.max PR02" \
-i "pandas.Timestamp.min PR02" \
-i "pandas.Timestamp.nanosecond GL08" \
Expand Down
15 changes: 15 additions & 0 deletions pandas/_libs/tslibs/timedeltas.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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.

min : Timedelta
Returns the minimum Timedelta value that can be created or used in
pandas operations.
Fixed at -106752 days +00:12:43.145224193
max : Timedelta
Returns the maximum Timedelta value that can be created or used in
pandas operations.
Fixed at 106751 days 23:47:16.854775807.

See Also
--------
Timestamp : Represents a single timestamp in time.
Expand Down
Loading