Skip to content

Fix part of docstring timedelta #59698 #59722

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

Closed
wants to merge 2 commits into from
Closed

Fix part of docstring timedelta #59698 #59722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4393a48
Add documentation for min, max, and resolution attributes of Timedelta
ammar-qazi Sep 5, 2024
fa1f22f
Fixed issues after the review.
ammar-qazi Sep 5, 2024
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 @@ -104,9 +104,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.sparse.npoints SA01" \
-i "pandas.Series.sparse.sp_values SA01" \
-i "pandas.Timedelta.components SA01" \
-i "pandas.Timedelta.max PR02" \
-i "pandas.Timedelta.min PR02" \
-i "pandas.Timedelta.resolution PR02" \
-i "pandas.Timedelta.to_timedelta64 SA01" \
-i "pandas.Timedelta.total_seconds SA01" \
-i "pandas.TimedeltaIndex.to_pytimedelta RT03,SA01" \
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 @@ -1857,6 +1857,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
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).
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