From 8169b6b951b0994ac33889164028a9e3e05b7036 Mon Sep 17 00:00:00 2001 From: Allison Kwan <73047650+allisonkwan@users.noreply.github.com> Date: Fri, 31 Mar 2023 13:12:05 -0400 Subject: [PATCH] DOC: Include timedelta as freq for timedelta_range, interval_range, and date_range (#52307) DOC: Include timedelta as freq --- pandas/core/indexes/datetimes.py | 2 +- pandas/core/indexes/interval.py | 2 +- pandas/core/indexes/timedeltas.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/indexes/datetimes.py b/pandas/core/indexes/datetimes.py index d1245e8856ab29..3cf84804e0ae10 100644 --- a/pandas/core/indexes/datetimes.py +++ b/pandas/core/indexes/datetimes.py @@ -790,7 +790,7 @@ def date_range( Right bound for generating dates. periods : int, optional Number of periods to generate. - freq : str, datetime.timedelta, or DateOffset, default 'D' + freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'D' Frequency strings can have multiples, e.g. '5H'. See :ref:`here ` for a list of frequency aliases. diff --git a/pandas/core/indexes/interval.py b/pandas/core/indexes/interval.py index a686176d41acba..19bf24ac3746da 100644 --- a/pandas/core/indexes/interval.py +++ b/pandas/core/indexes/interval.py @@ -991,7 +991,7 @@ def interval_range( Right bound for generating intervals. periods : int, default None Number of periods to generate. - freq : numeric, str, datetime.timedelta, or DateOffset, default None + freq : numeric, str, Timedelta, datetime.timedelta, or DateOffset, default None The length of each interval. Must be consistent with the type of start and end, e.g. 2 for numeric, or '5H' for datetime-like. Default is 1 for numeric and 'D' for datetime-like. diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index 18b6ca583582cd..de5e5c61e96f19 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -246,7 +246,7 @@ def timedelta_range( Right bound for generating timedeltas. periods : int, default None Number of periods to generate. - freq : str or DateOffset, default 'D' + freq : str, Timedelta, datetime.timedelta, or DateOffset, default 'D' Frequency strings can have multiples, e.g. '5H'. name : str, default None Name of the resulting TimedeltaIndex.