Skip to content

Commit e7124c7

Browse files
DOC: add PR07,SA01 for pandas.Timedelta (#58780)
* DOC: add PR07,SA01 for pandas.Timedelta * DOC: fix SA01, PR07
1 parent f32a8cd commit e7124c7

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

ci/code_checks.sh

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -222,16 +222,15 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
222222
-i "pandas.Series.to_markdown SA01" \
223223
-i "pandas.Series.to_string SA01" \
224224
-i "pandas.Series.update PR07,SA01" \
225-
-i "pandas.Timedelta PR07,SA01" \
226225
-i "pandas.Timedelta.as_unit SA01" \
227226
-i "pandas.Timedelta.asm8 SA01" \
228227
-i "pandas.Timedelta.ceil SA01" \
229228
-i "pandas.Timedelta.components SA01" \
230229
-i "pandas.Timedelta.days SA01" \
231230
-i "pandas.Timedelta.floor SA01" \
232-
-i "pandas.Timedelta.max PR02,PR07,SA01" \
233-
-i "pandas.Timedelta.min PR02,PR07,SA01" \
234-
-i "pandas.Timedelta.resolution PR02,PR07,SA01" \
231+
-i "pandas.Timedelta.max PR02" \
232+
-i "pandas.Timedelta.min PR02" \
233+
-i "pandas.Timedelta.resolution PR02" \
235234
-i "pandas.Timedelta.round SA01" \
236235
-i "pandas.Timedelta.to_numpy PR01" \
237236
-i "pandas.Timedelta.to_timedelta64 SA01" \
@@ -264,7 +263,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
264263
-i "pandas.Timestamp.now SA01" \
265264
-i "pandas.Timestamp.quarter SA01" \
266265
-i "pandas.Timestamp.replace PR07,SA01" \
267-
-i "pandas.Timestamp.resolution PR02,PR07,SA01" \
266+
-i "pandas.Timestamp.resolution PR02" \
268267
-i "pandas.Timestamp.second GL08" \
269268
-i "pandas.Timestamp.strptime PR01,SA01" \
270269
-i "pandas.Timestamp.time SA01" \

pandas/_libs/tslibs/timedeltas.pyx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1785,6 +1785,7 @@ class Timedelta(_Timedelta):
17851785
Parameters
17861786
----------
17871787
value : Timedelta, timedelta, np.timedelta64, str, or int
1788+
Input value.
17881789
unit : str, default 'ns'
17891790
Denote the unit of the input, if input is an integer.
17901791
@@ -1810,6 +1811,15 @@ class Timedelta(_Timedelta):
18101811
Values for construction in compat with datetime.timedelta.
18111812
Numpy ints and floats will be coerced to python ints and floats.
18121813
1814+
See Also
1815+
--------
1816+
Timestamp : Represents a single timestamp in time.
1817+
TimedeltaIndex : Immutable Index of timedelta64 data.
1818+
DateOffset : Standard kind of date increment used for a date range.
1819+
to_timedelta : Convert argument to timedelta.
1820+
datetime.timedelta : Represents a duration in the datetime module.
1821+
numpy.timedelta64 : Represents a duration compatible with NumPy.
1822+
18131823
Notes
18141824
-----
18151825
The constructor may take in either both values of value and unit or

0 commit comments

Comments
 (0)