Skip to content

DOC: Clarify where to the additional arguments for some win_types #34615

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.

Sign up for GitHub

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 9 commits into from
Jun 18, 2020
Merged

DOC: Clarify where to the additional arguments for some win_types #34615

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
711add5
DOC: Clarify some syntax when using win_types
linnndachen Jun 6, 2020
a3e38ac
DOC: Clarify where to the additional arguments for some win_types
linnndachen Jun 6, 2020
45be538
DOC: Clarify where to the additional arguments for some win_types
linnndachen Jun 6, 2020
05ed0eb
Revert "DOC: Clarify where to the additional arguments for some win_t…
linnndachen Jun 6, 2020
bd5c743
Revert "Revert "DOC: Clarify where to the additional arguments for so…
linnndachen Jun 6, 2020
0b36ff1
DOC: Remove whitespace in docstring
linnndachen Jun 6, 2020
de76df8
DOC: Remove indent of line934
linnndachen Jun 7, 2020
edfb124
Update pandas/core/window/rolling.py
linnndachen Jun 9, 2020
af9f991
Merge remote-tracking branch 'upstream/master' into patch-2
TomAugspurger Jun 17, 2020
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
13 changes: 8 additions & 5 deletions pandas/core/window/rolling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -922,16 +922,19 @@ class Window(_Window):
* ``blackmanharris``
* ``nuttall``
* ``barthann``
* ``kaiser`` (needs beta)
* ``gaussian`` (needs std)
* ``general_gaussian`` (needs power, width)
* ``slepian`` (needs width)
* ``exponential`` (needs tau), center is set to None.
* ``kaiser`` (needs parameter: beta)
* ``gaussian`` (needs parameter: std)
* ``general_gaussian`` (needs parameters: power, width)
* ``slepian`` (needs parameter: width)
* ``exponential`` (needs parameter: tau), center is set to None.

If ``win_type=None`` all points are evenly weighted. To learn more about
different window types see `scipy.signal window functions
<https://docs.scipy.org/doc/scipy/reference/signal.html#window-functions>`__.

Certain window types require additional parameters to be passed. Please see
the third example below on how to add the additional parameters.

Examples
--------
>>> df = pd.DataFrame({'B': [0, 1, 2, np.nan, 4]})
Expand Down