Skip to content

Commit 98b3e4c

Browse files
datapythonistajreback
authored andcommitted
DOC: Adding links to offset classes in timeseries.rst (#24448)
1 parent 74db5b5 commit 98b3e4c

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

doc/source/timeseries.rst

+34-34
Original file line numberDiff line numberDiff line change
@@ -855,40 +855,40 @@ into ``freq`` keyword arguments. The available date offsets and associated frequ
855855
:header: "Date Offset", "Frequency String", "Description"
856856
:widths: 15, 15, 65
857857

858-
``DateOffset``, None, "Generic offset class, defaults to 1 calendar day"
859-
``BDay`` or ``BusinessDay``, ``'B'``,"business day (weekday)"
860-
``CDay`` or ``CustomBusinessDay``, ``'C'``, "custom business day"
861-
``Week``, ``'W'``, "one week, optionally anchored on a day of the week"
862-
``WeekOfMonth``, ``'WOM'``, "the x-th day of the y-th week of each month"
863-
``LastWeekOfMonth``, ``'LWOM'``, "the x-th day of the last week of each month"
864-
``MonthEnd``, ``'M'``, "calendar month end"
865-
``MonthBegin``, ``'MS'``, "calendar month begin"
866-
``BMonthEnd`` or ``BusinessMonthEnd``, ``'BM'``, "business month end"
867-
``BMonthBegin`` or ``BusinessMonthBegin``, ``'BMS'``, "business month begin"
868-
``CBMonthEnd`` or ``CustomBusinessMonthEnd``, ``'CBM'``, "custom business month end"
869-
``CBMonthBegin`` or ``CustomBusinessMonthBegin``, ``'CBMS'``, "custom business month begin"
870-
``SemiMonthEnd``, ``'SM'``, "15th (or other day_of_month) and calendar month end"
871-
``SemiMonthBegin``, ``'SMS'``, "15th (or other day_of_month) and calendar month begin"
872-
``QuarterEnd``, ``'Q'``, "calendar quarter end"
873-
``QuarterBegin``, ``'QS'``, "calendar quarter begin"
874-
``BQuarterEnd``, ``'BQ``, "business quarter end"
875-
``BQuarterBegin``, ``'BQS'``, "business quarter begin"
876-
``FY5253Quarter``, ``'REQ'``, "retail (aka 52-53 week) quarter"
877-
``YearEnd``, ``'A'``, "calendar year end"
878-
``YearBegin``, ``'AS'`` or ``'BYS'``,"calendar year begin"
879-
``BYearEnd``, ``'BA'``, "business year end"
880-
``BYearBegin``, ``'BAS'``, "business year begin"
881-
``FY5253``, ``'RE'``, "retail (aka 52-53 week) year"
882-
``Easter``, None, "Easter holiday"
883-
``BusinessHour``, ``'BH'``, "business hour"
884-
``CustomBusinessHour``, ``'CBH'``, "custom business hour"
885-
``Day``, ``'D'``, "one absolute day"
886-
``Hour``, ``'H'``, "one hour"
887-
``Minute``, ``'T'`` or ``'min'``,"one minute"
888-
``Second``, ``'S'``, "one second"
889-
``Milli``, ``'L'`` or ``'ms'``, "one millisecond"
890-
``Micro``, ``'U'`` or ``'us'``, "one microsecond"
891-
``Nano``, ``'N'``, "one nanosecond"
858+
:class:`~pandas.tseries.offsets.DateOffset`, None, "Generic offset class, defaults to 1 calendar day"
859+
:class:`~pandas.tseries.offsets.BDay` or :class:`~pandas.tseries.offsets.BusinessDay`, ``'B'``,"business day (weekday)"
860+
:class:`~pandas.tseries.offsets.CDay` or :class:`~pandas.tseries.offsets.CustomBusinessDay`, ``'C'``, "custom business day"
861+
:class:`~pandas.tseries.offsets.Week`, ``'W'``, "one week, optionally anchored on a day of the week"
862+
:class:`~pandas.tseries.offsets.WeekOfMonth`, ``'WOM'``, "the x-th day of the y-th week of each month"
863+
:class:`~pandas.tseries.offsets.LastWeekOfMonth`, ``'LWOM'``, "the x-th day of the last week of each month"
864+
:class:`~pandas.tseries.offsets.MonthEnd`, ``'M'``, "calendar month end"
865+
:class:`~pandas.tseries.offsets.MonthBegin`, ``'MS'``, "calendar month begin"
866+
:class:`~pandas.tseries.offsets.BMonthEnd` or :class:`~pandas.tseries.offsets.BusinessMonthEnd`, ``'BM'``, "business month end"
867+
:class:`~pandas.tseries.offsets.BMonthBegin` or :class:`~pandas.tseries.offsets.BusinessMonthBegin`, ``'BMS'``, "business month begin"
868+
:class:`~pandas.tseries.offsets.CBMonthEnd` or :class:`~pandas.tseries.offsets.CustomBusinessMonthEnd`, ``'CBM'``, "custom business month end"
869+
:class:`~pandas.tseries.offsets.CBMonthBegin` or :class:`~pandas.tseries.offsets.CustomBusinessMonthBegin`, ``'CBMS'``, "custom business month begin"
870+
:class:`~pandas.tseries.offsets.SemiMonthEnd`, ``'SM'``, "15th (or other day_of_month) and calendar month end"
871+
:class:`~pandas.tseries.offsets.SemiMonthBegin`, ``'SMS'``, "15th (or other day_of_month) and calendar month begin"
872+
:class:`~pandas.tseries.offsets.QuarterEnd`, ``'Q'``, "calendar quarter end"
873+
:class:`~pandas.tseries.offsets.QuarterBegin`, ``'QS'``, "calendar quarter begin"
874+
:class:`~pandas.tseries.offsets.BQuarterEnd`, ``'BQ``, "business quarter end"
875+
:class:`~pandas.tseries.offsets.BQuarterBegin`, ``'BQS'``, "business quarter begin"
876+
:class:`~pandas.tseries.offsets.FY5253Quarter`, ``'REQ'``, "retail (aka 52-53 week) quarter"
877+
:class:`~pandas.tseries.offsets.YearEnd`, ``'A'``, "calendar year end"
878+
:class:`~pandas.tseries.offsets.YearBegin`, ``'AS'`` or ``'BYS'``,"calendar year begin"
879+
:class:`~pandas.tseries.offsets.BYearEnd`, ``'BA'``, "business year end"
880+
:class:`~pandas.tseries.offsets.BYearBegin`, ``'BAS'``, "business year begin"
881+
:class:`~pandas.tseries.offsets.FY5253`, ``'RE'``, "retail (aka 52-53 week) year"
882+
:class:`~pandas.tseries.offsets.Easter`, None, "Easter holiday"
883+
:class:`~pandas.tseries.offsets.BusinessHour`, ``'BH'``, "business hour"
884+
:class:`~pandas.tseries.offsets.CustomBusinessHour`, ``'CBH'``, "custom business hour"
885+
:class:`~pandas.tseries.offsets.Day`, ``'D'``, "one absolute day"
886+
:class:`~pandas.tseries.offsets.Hour`, ``'H'``, "one hour"
887+
:class:`~pandas.tseries.offsets.Minute`, ``'T'`` or ``'min'``,"one minute"
888+
:class:`~pandas.tseries.offsets.Second`, ``'S'``, "one second"
889+
:class:`~pandas.tseries.offsets.Milli`, ``'L'`` or ``'ms'``, "one millisecond"
890+
:class:`~pandas.tseries.offsets.Micro`, ``'U'`` or ``'us'``, "one microsecond"
891+
:class:`~pandas.tseries.offsets.Nano`, ``'N'``, "one nanosecond"
892892

893893
``DateOffsets`` additionally have :meth:`rollforward` and :meth:`rollback`
894894
methods for moving a date forward or backward respectively to a valid offset

0 commit comments

Comments
 (0)