From 98b3e4ca141f4008eab7e10e49586389d86db42d Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Thu, 27 Dec 2018 16:46:42 +0000 Subject: [PATCH] DOC: Adding links to offset classes in timeseries.rst (#24448) --- doc/source/timeseries.rst | 68 +++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/doc/source/timeseries.rst b/doc/source/timeseries.rst index 349827f1e8807..59e8fa58fd9cf 100644 --- a/doc/source/timeseries.rst +++ b/doc/source/timeseries.rst @@ -855,40 +855,40 @@ into ``freq`` keyword arguments. The available date offsets and associated frequ :header: "Date Offset", "Frequency String", "Description" :widths: 15, 15, 65 - ``DateOffset``, None, "Generic offset class, defaults to 1 calendar day" - ``BDay`` or ``BusinessDay``, ``'B'``,"business day (weekday)" - ``CDay`` or ``CustomBusinessDay``, ``'C'``, "custom business day" - ``Week``, ``'W'``, "one week, optionally anchored on a day of the week" - ``WeekOfMonth``, ``'WOM'``, "the x-th day of the y-th week of each month" - ``LastWeekOfMonth``, ``'LWOM'``, "the x-th day of the last week of each month" - ``MonthEnd``, ``'M'``, "calendar month end" - ``MonthBegin``, ``'MS'``, "calendar month begin" - ``BMonthEnd`` or ``BusinessMonthEnd``, ``'BM'``, "business month end" - ``BMonthBegin`` or ``BusinessMonthBegin``, ``'BMS'``, "business month begin" - ``CBMonthEnd`` or ``CustomBusinessMonthEnd``, ``'CBM'``, "custom business month end" - ``CBMonthBegin`` or ``CustomBusinessMonthBegin``, ``'CBMS'``, "custom business month begin" - ``SemiMonthEnd``, ``'SM'``, "15th (or other day_of_month) and calendar month end" - ``SemiMonthBegin``, ``'SMS'``, "15th (or other day_of_month) and calendar month begin" - ``QuarterEnd``, ``'Q'``, "calendar quarter end" - ``QuarterBegin``, ``'QS'``, "calendar quarter begin" - ``BQuarterEnd``, ``'BQ``, "business quarter end" - ``BQuarterBegin``, ``'BQS'``, "business quarter begin" - ``FY5253Quarter``, ``'REQ'``, "retail (aka 52-53 week) quarter" - ``YearEnd``, ``'A'``, "calendar year end" - ``YearBegin``, ``'AS'`` or ``'BYS'``,"calendar year begin" - ``BYearEnd``, ``'BA'``, "business year end" - ``BYearBegin``, ``'BAS'``, "business year begin" - ``FY5253``, ``'RE'``, "retail (aka 52-53 week) year" - ``Easter``, None, "Easter holiday" - ``BusinessHour``, ``'BH'``, "business hour" - ``CustomBusinessHour``, ``'CBH'``, "custom business hour" - ``Day``, ``'D'``, "one absolute day" - ``Hour``, ``'H'``, "one hour" - ``Minute``, ``'T'`` or ``'min'``,"one minute" - ``Second``, ``'S'``, "one second" - ``Milli``, ``'L'`` or ``'ms'``, "one millisecond" - ``Micro``, ``'U'`` or ``'us'``, "one microsecond" - ``Nano``, ``'N'``, "one nanosecond" + :class:`~pandas.tseries.offsets.DateOffset`, None, "Generic offset class, defaults to 1 calendar day" + :class:`~pandas.tseries.offsets.BDay` or :class:`~pandas.tseries.offsets.BusinessDay`, ``'B'``,"business day (weekday)" + :class:`~pandas.tseries.offsets.CDay` or :class:`~pandas.tseries.offsets.CustomBusinessDay`, ``'C'``, "custom business day" + :class:`~pandas.tseries.offsets.Week`, ``'W'``, "one week, optionally anchored on a day of the week" + :class:`~pandas.tseries.offsets.WeekOfMonth`, ``'WOM'``, "the x-th day of the y-th week of each month" + :class:`~pandas.tseries.offsets.LastWeekOfMonth`, ``'LWOM'``, "the x-th day of the last week of each month" + :class:`~pandas.tseries.offsets.MonthEnd`, ``'M'``, "calendar month end" + :class:`~pandas.tseries.offsets.MonthBegin`, ``'MS'``, "calendar month begin" + :class:`~pandas.tseries.offsets.BMonthEnd` or :class:`~pandas.tseries.offsets.BusinessMonthEnd`, ``'BM'``, "business month end" + :class:`~pandas.tseries.offsets.BMonthBegin` or :class:`~pandas.tseries.offsets.BusinessMonthBegin`, ``'BMS'``, "business month begin" + :class:`~pandas.tseries.offsets.CBMonthEnd` or :class:`~pandas.tseries.offsets.CustomBusinessMonthEnd`, ``'CBM'``, "custom business month end" + :class:`~pandas.tseries.offsets.CBMonthBegin` or :class:`~pandas.tseries.offsets.CustomBusinessMonthBegin`, ``'CBMS'``, "custom business month begin" + :class:`~pandas.tseries.offsets.SemiMonthEnd`, ``'SM'``, "15th (or other day_of_month) and calendar month end" + :class:`~pandas.tseries.offsets.SemiMonthBegin`, ``'SMS'``, "15th (or other day_of_month) and calendar month begin" + :class:`~pandas.tseries.offsets.QuarterEnd`, ``'Q'``, "calendar quarter end" + :class:`~pandas.tseries.offsets.QuarterBegin`, ``'QS'``, "calendar quarter begin" + :class:`~pandas.tseries.offsets.BQuarterEnd`, ``'BQ``, "business quarter end" + :class:`~pandas.tseries.offsets.BQuarterBegin`, ``'BQS'``, "business quarter begin" + :class:`~pandas.tseries.offsets.FY5253Quarter`, ``'REQ'``, "retail (aka 52-53 week) quarter" + :class:`~pandas.tseries.offsets.YearEnd`, ``'A'``, "calendar year end" + :class:`~pandas.tseries.offsets.YearBegin`, ``'AS'`` or ``'BYS'``,"calendar year begin" + :class:`~pandas.tseries.offsets.BYearEnd`, ``'BA'``, "business year end" + :class:`~pandas.tseries.offsets.BYearBegin`, ``'BAS'``, "business year begin" + :class:`~pandas.tseries.offsets.FY5253`, ``'RE'``, "retail (aka 52-53 week) year" + :class:`~pandas.tseries.offsets.Easter`, None, "Easter holiday" + :class:`~pandas.tseries.offsets.BusinessHour`, ``'BH'``, "business hour" + :class:`~pandas.tseries.offsets.CustomBusinessHour`, ``'CBH'``, "custom business hour" + :class:`~pandas.tseries.offsets.Day`, ``'D'``, "one absolute day" + :class:`~pandas.tseries.offsets.Hour`, ``'H'``, "one hour" + :class:`~pandas.tseries.offsets.Minute`, ``'T'`` or ``'min'``,"one minute" + :class:`~pandas.tseries.offsets.Second`, ``'S'``, "one second" + :class:`~pandas.tseries.offsets.Milli`, ``'L'`` or ``'ms'``, "one millisecond" + :class:`~pandas.tseries.offsets.Micro`, ``'U'`` or ``'us'``, "one microsecond" + :class:`~pandas.tseries.offsets.Nano`, ``'N'``, "one nanosecond" ``DateOffsets`` additionally have :meth:`rollforward` and :meth:`rollback` methods for moving a date forward or backward respectively to a valid offset