Skip to content

Commit af513bb

Browse files
authored
DOC: Include timedelta as freq for timedelta_range, interval_range, and date_range (#52307)
DOC: Include timedelta as freq
1 parent 379f9c0 commit af513bb

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

pandas/core/indexes/datetimes.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -790,7 +790,7 @@ def date_range(
790790
Right bound for generating dates.
791791
periods : int, optional
792792
Number of periods to generate.
793-
freq : str, datetime.timedelta, or DateOffset, default 'D'
793+
freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'D'
794794
Frequency strings can have multiples, e.g. '5H'. See
795795
:ref:`here <timeseries.offset_aliases>` for a list of
796796
frequency aliases.

pandas/core/indexes/interval.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -991,7 +991,7 @@ def interval_range(
991991
Right bound for generating intervals.
992992
periods : int, default None
993993
Number of periods to generate.
994-
freq : numeric, str, datetime.timedelta, or DateOffset, default None
994+
freq : numeric, str, Timedelta, datetime.timedelta, or DateOffset, default None
995995
The length of each interval. Must be consistent with the type of start
996996
and end, e.g. 2 for numeric, or '5H' for datetime-like. Default is 1
997997
for numeric and 'D' for datetime-like.

pandas/core/indexes/timedeltas.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ def timedelta_range(
246246
Right bound for generating timedeltas.
247247
periods : int, default None
248248
Number of periods to generate.
249-
freq : str or DateOffset, default 'D'
249+
freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'D'
250250
Frequency strings can have multiples, e.g. '5H'.
251251
name : str, default None
252252
Name of the resulting TimedeltaIndex.

0 commit comments

Comments
 (0)