Skip to content

Commit 01966a7

Browse files
update docstrings
1 parent eec8818 commit 01966a7

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

pandas/core/arrays/datetimelike.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -927,7 +927,7 @@ def inferred_freq(self) -> str | None:
927927
>>> tdelta_idx = pd.to_timedelta(["0 days", "10 days", "20 days"])
928928
>>> tdelta_idx
929929
TimedeltaIndex(['0 days', '10 days', '20 days'],
930-
dtype='timedelta64[ns]', freq=None)
930+
dtype='timedelta64[us]', freq=None)
931931
>>> tdelta_idx.inferred_freq
932932
'10D'
933933
"""

pandas/core/arrays/timedeltas.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ class TimedeltaArray(dtl.TimelikeOps):
150150
>>> pd.arrays.TimedeltaArray._from_sequence(pd.TimedeltaIndex(["1h", "2h"]))
151151
<TimedeltaArray>
152152
['0 days 01:00:00', '0 days 02:00:00']
153-
Length: 2, dtype: timedelta64[ns]
153+
Length: 2, dtype: timedelta64[us]
154154
"""
155155

156156
_typ = "timedeltaarray"
@@ -813,7 +813,7 @@ def total_seconds(self) -> npt.NDArray[np.float64]:
813813
>>> idx = pd.to_timedelta(np.arange(5), unit="D")
814814
>>> idx
815815
TimedeltaIndex(['0 days', '1 days', '2 days', '3 days', '4 days'],
816-
dtype='timedelta64[ns]', freq=None)
816+
dtype='timedelta64[us]', freq=None)
817817
818818
>>> idx.total_seconds()
819819
Index([0.0, 86400.0, 172800.0, 259200.0, 345600.0], dtype='float64')
@@ -892,7 +892,7 @@ def to_pytimedelta(self) -> npt.NDArray[np.object_]:
892892
>>> tdelta_idx = pd.to_timedelta(["0 days", "10 days", "20 days"])
893893
>>> tdelta_idx
894894
TimedeltaIndex(['0 days', '10 days', '20 days'],
895-
dtype='timedelta64[ns]', freq=None)
895+
dtype='timedelta64[us]', freq=None)
896896
>>> tdelta_idx.days
897897
Index([0, 10, 20], dtype='int64')"""
898898
)

pandas/core/generic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1560,7 +1560,7 @@ def abs(self) -> Self:
15601560
>>> s = pd.Series([pd.Timedelta("1 days")])
15611561
>>> s.abs()
15621562
0 1 days
1563-
dtype: timedelta64[ns]
1563+
dtype: timedelta64[us]
15641564
15651565
Select rows with data closest to certain value using argsort (from
15661566
`StackOverflow <https://stackoverflow.com/a/17758115>`__).

pandas/core/indexes/accessors.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ class TimedeltaProperties(Properties):
453453
0 0 days 00:00:01
454454
1 0 days 00:00:02
455455
2 0 days 00:00:03
456-
dtype: timedelta64[ns]
456+
dtype: timedelta64[us]
457457
>>> seconds_series.dt.seconds
458458
0 1
459459
1 2

pandas/core/indexes/datetimelike.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@ def inferred_freq(self) -> str | None:
691691
>>> tdelta_idx = pd.to_timedelta(["0 days", "10 days", "20 days"])
692692
>>> tdelta_idx
693693
TimedeltaIndex(['0 days', '10 days', '20 days'],
694-
dtype='timedelta64[ns]', freq=None)
694+
dtype='timedelta64[us]', freq=None)
695695
>>> tdelta_idx.inferred_freq
696696
'10D'
697697
"""

pandas/core/indexes/timedeltas.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ class TimedeltaIndex(DatetimeTimedeltaMixin):
122122
--------
123123
>>> pd.TimedeltaIndex(["0 days", "1 days", "2 days", "3 days", "4 days"])
124124
TimedeltaIndex(['0 days', '1 days', '2 days', '3 days', '4 days'],
125-
dtype='timedelta64[ns]', freq=None)
125+
dtype='timedelta64[us]', freq=None)
126126
127127
We can also let pandas infer the frequency when possible.
128128
@@ -319,14 +319,14 @@ def timedelta_range(
319319
--------
320320
>>> pd.timedelta_range(start="1 day", periods=4)
321321
TimedeltaIndex(['1 days', '2 days', '3 days', '4 days'],
322-
dtype='timedelta64[ns]', freq='D')
322+
dtype='timedelta64[us]', freq='D')
323323
324324
The ``closed`` parameter specifies which endpoint is included. The default
325325
behavior is to include both endpoints.
326326
327327
>>> pd.timedelta_range(start="1 day", periods=4, closed="right")
328328
TimedeltaIndex(['2 days', '3 days', '4 days'],
329-
dtype='timedelta64[ns]', freq='D')
329+
dtype='timedelta64[us]', freq='D')
330330
331331
The ``freq`` parameter specifies the frequency of the TimedeltaIndex.
332332
Only fixed frequencies can be passed, non-fixed frequencies such as
@@ -335,15 +335,15 @@ def timedelta_range(
335335
>>> pd.timedelta_range(start="1 day", end="2 days", freq="6h")
336336
TimedeltaIndex(['1 days 00:00:00', '1 days 06:00:00', '1 days 12:00:00',
337337
'1 days 18:00:00', '2 days 00:00:00'],
338-
dtype='timedelta64[ns]', freq='6h')
338+
dtype='timedelta64[us]', freq='6h')
339339
340340
Specify ``start``, ``end``, and ``periods``; the frequency is generated
341341
automatically (linearly spaced).
342342
343343
>>> pd.timedelta_range(start="1 day", end="5 days", periods=4)
344344
TimedeltaIndex(['1 days 00:00:00', '2 days 08:00:00', '3 days 16:00:00',
345345
'5 days 00:00:00'],
346-
dtype='timedelta64[ns]', freq=None)
346+
dtype='timedelta64[us]', freq=None)
347347
348348
**Specify a unit**
349349

pandas/core/tools/timedeltas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ def to_timedelta(
174174
dtype='timedelta64[ns]', freq=None)
175175
>>> pd.to_timedelta(np.arange(5), unit="D")
176176
TimedeltaIndex(['0 days', '1 days', '2 days', '3 days', '4 days'],
177-
dtype='timedelta64[ns]', freq=None)
177+
dtype='timedelta64[us]', freq=None)
178178
"""
179179
if unit is not None:
180180
unit = parse_timedelta_unit(unit)

0 commit comments

Comments
 (0)