Skip to content

Commit 02c44bb

Browse files
committed
Add reference to frequency strings; fixes pandas-dev#13160
1 parent 7c357d2 commit 02c44bb

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

doc/source/timeseries.rst

+8-5
Original file line numberDiff line numberDiff line change
@@ -567,11 +567,11 @@ DateOffset objects
567567
------------------
568568

569569
In the preceding examples, we created DatetimeIndex objects at various
570-
frequencies by passing in frequency strings like 'M', 'W', and 'BM to the
571-
``freq`` keyword. Under the hood, these frequency strings are being translated
572-
into an instance of pandas ``DateOffset``, which represents a regular
573-
frequency increment. Specific offset logic like "month", "business day", or
574-
"one hour" is represented in its various subclasses.
570+
frequencies by passing in :ref: `frequency strings <timeseries.offset_aliases>`
571+
like 'M', 'W', and 'BM to the ``freq`` keyword. Under the hood, these frequency
572+
strings are being translated into an instance of pandas ``DateOffset``,
573+
which represents a regular frequency increment. Specific offset logic like
574+
"month", "business day", or "one hour" is represented in its various subclasses.
575575

576576
.. csv-table::
577577
:header: "Class name", "Description"
@@ -953,6 +953,9 @@ You can use keyword arguments suported by either ``BusinessHour`` and ``CustomBu
953953
# Monday is skipped because it's a holiday, business hour starts from 10:00
954954
dt + bhour_mon * 2
955955
956+
957+
.. _timeseries.offset_aliases:
958+
956959
Offset Aliases
957960
~~~~~~~~~~~~~~
958961

pandas/core/window.py

+2
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,8 @@ class Window(_Window):
312312
* ``gaussian`` (needs std)
313313
* ``general_gaussian`` (needs power, width)
314314
* ``slepian`` (needs width).
315+
316+
To know more about the frequency strings, please visit this link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
315317
"""
316318

317319
def validate(self):

0 commit comments

Comments
 (0)