Skip to content

Commit e215121

Browse files
DOC: fix SA01,ES01 for pandas.Timedelta.total_seconds (pandas-dev#59800)
* DOC: fix SA01,ES01 for pandas.Timedelta.total_seconds * DOC: fix SA01,ES01 for pandas.Timedelta.total_seconds
1 parent e3bcd10 commit e215121

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
105105
-i "pandas.Timedelta.min PR02" \
106106
-i "pandas.Timedelta.resolution PR02" \
107107
-i "pandas.Timedelta.to_timedelta64 SA01" \
108-
-i "pandas.Timedelta.total_seconds SA01" \
109108
-i "pandas.TimedeltaIndex.to_pytimedelta RT03,SA01" \
110109
-i "pandas.Timestamp.max PR02" \
111110
-i "pandas.Timestamp.min PR02" \

pandas/_libs/tslibs/nattype.pyx

+8
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,14 @@ class NaTType(_NaT):
493493
"""
494494
Total seconds in the duration.
495495
496+
This method calculates the total duration in seconds by combining
497+
the days, seconds, and microseconds of the `Timedelta` object.
498+
499+
See Also
500+
--------
501+
to_timedelta : Convert argument to timedelta.
502+
Timedelta : Represents a duration, the difference between two dates or times.
503+
496504
Examples
497505
--------
498506
>>> td = pd.Timedelta('1min')

pandas/_libs/tslibs/timedeltas.pyx

+8
Original file line numberDiff line numberDiff line change
@@ -1189,6 +1189,14 @@ cdef class _Timedelta(timedelta):
11891189
"""
11901190
Total seconds in the duration.
11911191

1192+
This method calculates the total duration in seconds by combining
1193+
the days, seconds, and microseconds of the `Timedelta` object.
1194+
1195+
See Also
1196+
--------
1197+
to_timedelta : Convert argument to timedelta.
1198+
Timedelta : Represents a duration, the difference between two dates or times.
1199+
11921200
Examples
11931201
--------
11941202
>>> td = pd.Timedelta('1min')

0 commit comments

Comments
 (0)