Skip to content

DOC: update Rolling.std docstring #20235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 59 additions & 4 deletions pandas/core/window.py
Original file line number Diff line number Diff line change
Expand Up @@ -857,13 +857,70 @@ def median(self, **kwargs):
return self._apply('roll_median_c', 'median', **kwargs)

_shared_docs['std'] = dedent("""
%(name)s standard deviation
Calculate %(name)s standard deviation.

Normalized by N-1 by default. This can be changed using the `ddof`
argument.

Parameters
----------
ddof : int, default 1
Delta Degrees of Freedom. The divisor used in calculations
is ``N - ddof``, where ``N`` represents the number of elements.""")
is ``N - ddof``, where ``N`` represents the number of elements.
*args
Under Review.
**kwargs
Under Review.

Returns
-------
Returns the same object type as determined by the caller of the %(name)s
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment here as on the other PR #20233

calculation.

See Also
--------
Series.%(name)s : Calling object with Series data
DataFrame.%(name)s : Calling object with DataFrames
Series.std : Equivalent method for Series
DataFrame.std : Equivalent method for DataFrame
numpy.std : Equivalent method for Numpy array

Notes
-----
A minimum of 1 periods is required for the rolling calculation.

Examples
--------
>>> s = pd.Series((5, 5, 5, 5, 6, 7, 9, 10, 5, 5, 5, 5))
>>> s.rolling(3).std()
0 NaN
1 NaN
2 0.000000
3 0.000000
4 0.577350
5 1.000000
6 1.527525
7 1.527525
8 2.645751
9 2.886751
10 0.000000
11 0.000000
dtype: float64
>>> s.expanding(3).std()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blank line between cases

0 NaN
1 NaN
2 0.000000
3 0.000000
4 0.447214
5 0.836660
6 1.527525
7 2.000000
8 1.936492
9 1.873796
10 1.814086
11 1.758098
dtype: float64
""")

def std(self, ddof=1, *args, **kwargs):
nv.validate_window_func('std', args, kwargs)
Expand Down Expand Up @@ -1250,7 +1307,6 @@ def median(self, **kwargs):
return super(Rolling, self).median(**kwargs)

@Substitution(name='rolling')
@Appender(_doc_template)
@Appender(_shared_docs['std'])
def std(self, ddof=1, *args, **kwargs):
nv.validate_rolling_func('std', args, kwargs)
Expand Down Expand Up @@ -1489,7 +1545,6 @@ def median(self, **kwargs):
return super(Expanding, self).median(**kwargs)

@Substitution(name='expanding')
@Appender(_doc_template)
@Appender(_shared_docs['std'])
def std(self, ddof=1, *args, **kwargs):
nv.validate_expanding_func('std', args, kwargs)
Expand Down