Skip to content

DOC: update the Rolling.var docstring #20233

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
51 changes: 47 additions & 4 deletions pandas/core/window.py
Original file line number Diff line number Diff line change
Expand Up @@ -879,13 +879,58 @@ def f(arg, *args, **kwargs):
ddof=ddof, **kwargs)

_shared_docs['var'] = dedent("""
%(name)s variance
Calculate unbiased %(name)s variance.

Normalized by N-1 by default. This can be changed using the ddof argument.
Copy link
Contributor

Choose a reason for hiding this comment

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

single backtics around ddof since it's a parameter.

Copy link
Member

Choose a reason for hiding this comment

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

Can you add backticks around ddof please?


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
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think the underlying function takes any additional arguments. Can remove (I think).

Copy link
Author

Choose a reason for hiding this comment

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

I can remove it, it looks like it passes them through, but I didn't dive into it's usage.. I'll remove for now.

Under Review.
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Author

Choose a reason for hiding this comment

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

It was mentioned that the exact content for what should be documented for args/kwargs was to be determined. If you'd rather me add the documentation I can do that too.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we're noting that they're accepted, but not used.

kwargs
Under Review.
Copy link
Member

Choose a reason for hiding this comment

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

*args and **kwargs should have the stars. We changed the convention last minute, and the validation script is wrong, ignore the messages.


Returns
-------
Series or DataFrame
Returned object type is determined by the caller of the %(name)s
Copy link
Contributor

Choose a reason for hiding this comment

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

It's always the same type as the original object, right? Series.rolling().var is always a Series? Let's say that.

Copy link
Member

Choose a reason for hiding this comment

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

But DataFrame.rolling().var() is a DataFrame, so that is what the above sentences tries to say. What do you want to change?

"is determined by " -> "same type as" ?

calculation

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

Notes
-----
Copy link
Contributor

Choose a reason for hiding this comment

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

so in both this one and the std one, should put in the Notes that the ddof default is different than numpy. (we use 1, they use 0). This is in the Series.var/std strings already.

Copy link
Author

Choose a reason for hiding this comment

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

👍

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

Examples
--------
The below example will show a rolling example
Copy link
Member

Choose a reason for hiding this comment

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

I'd take this sentence out, I think users will assume that.


>>> s = pd.Series((5,5,5,5,6,7,9,10,5,5,5,5))
Copy link
Member

Choose a reason for hiding this comment

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

Can you add spaces after the commas, so this passes PEP-8

>>> s.rolling(3).var(1)
0 NaN
1 NaN
2 0.000000
3 0.000000
4 0.333333
5 1.000000
6 2.333333
7 2.333333
8 7.000000
9 8.333333
10 0.000000
11 0.000000
dtype: float64
""")
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you show s.expanding(3).var(1) as well?


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

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

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