-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Fixing EX01 - Added examples #53982
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
Conversation
pandas/core/window/rolling.py
Outdated
""" | ||
>>> ser = pd.Series([0, 1, 5, 2, 8]) | ||
|
||
In order to get an instance of pandas.core.window.rolling.Window we need |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this link work? I think you may need to write :class:pandas.core.window.rolling.Window
, or :class:~pandas.core.window.rolling.Window
to hide part of the path
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you
pandas/core/window/rolling.py
Outdated
4 4.242641 | ||
dtype: float64 | ||
""" | ||
).replace("\n", "", 1), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same comment as in the other PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ouch... I just saw this one! - I'll change it.
pandas/core/window/rolling.py
Outdated
<class 'pandas.core.window.rolling.Window'> | ||
|
||
In order to use the `Sci-py` gaussian window we need to provide the parameters | ||
M and std. The parameter M corresponds to 2 in our example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add backticks to the variable names here? Like
`M` and `std`
The general rule (which admittedly isn't followed very consistently) from the numpy guide is to use single backticks for variable names, and double backticks otherwise
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I forgot about that.
pandas/core/window/rolling.py
Outdated
>>> type(ser.rolling(2, win_type='gaussian')) | ||
<class 'pandas.core.window.rolling.Window'> | ||
|
||
In order to use the `Sci-py` gaussian window we need to provide the parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can just write "SciPy"
also, gaussian => Gaussian
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
pandas/core/window/rolling.py
Outdated
"""\ | ||
>>> ser = pd.Series([0, 1, 5, 2, 8]) | ||
|
||
To get an instance of :class: ~pandas.core.window.rolling.Window we need |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might need to be
:class:`~pandas.core.window.rolling.Window`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done - thanks.
/preview |
Website preview of this PR available at: https://pandas.pydata.org/preview/53982/ |
Nice! Looks like there's just a merge conflict to resolve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice, should be good, thanks @DeaMariaLeon !
* Examples Window.mean, sum, var, std * Corrections to docstrings * Removed replace() * Correct link take 2 * remove replace() to right method
Towards #37875
I could not make the html of each method, so I'm not sure if everything looks well.
I'll use
/preview
here.