Skip to content

Commit 7b7045a

Browse files
committed
DOC: Add reference to frequency strings in docs
1 parent 02c44bb commit 7b7045a

File tree

4 files changed

+41
-1
lines changed

4 files changed

+41
-1
lines changed

pandas/core/window.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,8 @@ class Window(_Window):
313313
* ``general_gaussian`` (needs power, width)
314314
* ``slepian`` (needs width).
315315
316-
To know more about the frequency strings, please visit this link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
316+
To know more about the frequency strings (offset aliases), please visit this
317+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
317318
"""
318319

319320
def validate(self):

pandas/stats/moments.py

+21
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,9 @@ def rolling_count(arg, window, **kwargs):
271271
The `freq` keyword is used to conform time series data to a specified
272272
frequency by resampling the data. This is done with the default parameters
273273
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
274+
275+
To know more about the frequency strings (offset aliases), please visit this
276+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
274277
"""
275278
return ensure_compat('rolling', 'count', arg, window=window, **kwargs)
276279

@@ -521,6 +524,9 @@ def rolling_quantile(arg, window, quantile, min_periods=None, freq=None,
521524
The `freq` keyword is used to conform time series data to a specified
522525
frequency by resampling the data. This is done with the default parameters
523526
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
527+
528+
To know more about the frequency strings (offset aliases), please visit this
529+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
524530
"""
525531
return ensure_compat('rolling',
526532
'quantile',
@@ -570,6 +576,9 @@ def rolling_apply(arg, window, func, min_periods=None, freq=None,
570576
The `freq` keyword is used to conform time series data to a specified
571577
frequency by resampling the data. This is done with the default parameters
572578
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
579+
580+
To know more about the frequency strings (offset aliases), please visit this
581+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
573582
"""
574583
return ensure_compat('rolling',
575584
'apply',
@@ -642,6 +651,9 @@ def rolling_window(arg, window=None, win_type=None, min_periods=None,
642651
The `freq` keyword is used to conform time series data to a specified
643652
frequency by resampling the data. This is done with the default parameters
644653
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
654+
655+
To know more about the frequency strings (offset aliases), please visit this
656+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
645657
"""
646658
func = 'mean' if mean else 'sum'
647659
return ensure_compat('rolling',
@@ -707,6 +719,9 @@ def expanding_count(arg, freq=None):
707719
The `freq` keyword is used to conform time series data to a specified
708720
frequency by resampling the data. This is done with the default parameters
709721
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
722+
723+
To know more about the frequency strings (offset aliases), please visit this
724+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
710725
"""
711726
return ensure_compat('expanding', 'count', arg, freq=freq)
712727

@@ -735,6 +750,9 @@ def expanding_quantile(arg, quantile, min_periods=1, freq=None):
735750
The `freq` keyword is used to conform time series data to a specified
736751
frequency by resampling the data. This is done with the default parameters
737752
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
753+
754+
To know more about the frequency strings (offset aliases), please visit this
755+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
738756
"""
739757
return ensure_compat('expanding',
740758
'quantile',
@@ -818,6 +836,9 @@ def expanding_apply(arg, func, min_periods=1, freq=None,
818836
The `freq` keyword is used to conform time series data to a specified
819837
frequency by resampling the data. This is done with the default parameters
820838
of :meth:`~pandas.Series.resample` (i.e. using the `mean`).
839+
840+
To know more about the frequency strings (offset aliases), please visit this
841+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
821842
"""
822843
return ensure_compat('expanding',
823844
'apply',

pandas/tseries/index.py

+12
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,9 @@ class DatetimeIndex(DatelikeOps, TimelikeOps, DatetimeIndexOpsMixin,
178178
Attempt to infer fall dst-transition hours based on order
179179
name : object
180180
Name to be stored in the index
181+
182+
To know more about the frequency strings (offset aliases), please visit this
183+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
181184
"""
182185

183186
_typ = 'datetimeindex'
@@ -2071,6 +2074,9 @@ def date_range(start=None, end=None, periods=None, freq='D', tz=None,
20712074
-----
20722075
2 of start, end, or periods must be specified
20732076
2077+
To know more about the frequency strings (offset aliases), please visit this
2078+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
2079+
20742080
Returns
20752081
-------
20762082
rng : DatetimeIndex
@@ -2111,6 +2117,9 @@ def bdate_range(start=None, end=None, periods=None, freq='B', tz=None,
21112117
-----
21122118
2 of start, end, or periods must be specified
21132119
2120+
To know more about the frequency strings (offset aliases), please visit this
2121+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
2122+
21142123
Returns
21152124
-------
21162125
rng : DatetimeIndex
@@ -2162,6 +2171,9 @@ def cdate_range(start=None, end=None, periods=None, freq='C', tz=None,
21622171
-----
21632172
2 of start, end, or periods must be specified
21642173
2174+
To know more about the frequency strings (offset aliases), please visit this
2175+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
2176+
21652177
Returns
21662178
-------
21672179
rng : DatetimeIndex

pandas/tseries/tdi.py

+6
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ class TimedeltaIndex(DatetimeIndexOpsMixin, TimelikeOps, Int64Index):
101101
the 'left', 'right', or both sides (None)
102102
name : object
103103
Name to be stored in the index
104+
105+
To know more about the frequency strings (offset aliases), please visit this
106+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
104107
"""
105108

106109
_typ = 'timedeltaindex'
@@ -1001,6 +1004,9 @@ def timedelta_range(start=None, end=None, periods=None, freq='D',
10011004
Returns
10021005
-------
10031006
rng : TimedeltaIndex
1007+
1008+
To know more about the frequency strings (offset aliases), please visit this
1009+
link - http://pandas.pydata.org/pandas-docs/stable/timeseries.html#offset-aliases.
10041010
"""
10051011
return TimedeltaIndex(start=start, end=end, periods=periods,
10061012
freq=freq, name=name,

0 commit comments

Comments
 (0)