Skip to content

Commit 5d69786

Browse files
DOC: Clarify where to the additional arguments for some win_types (#34615)
* DOC: Clarify some syntax when using win_types DOC: Clarify where to the additional arguments for some win_types For example, std needs to specify when win_types is gaussian. However, std should be specified in the operation argument, not as one of the rolling arguments. This change is to clarify this point. Closes: #34593 * DOC: Clarify where to the additional arguments for some win_types Edit: 711add5 First Commit Original issue: #34615 * DOC: Clarify where to the additional arguments for some win_types Edit: a3e38ac Second Commit What's new: I shortened line 935 so that each line is less than 88 characters. Original Issue: #34615 * Revert "DOC: Clarify where to the additional arguments for some win_types" This reverts commit 45be538. * Revert "Revert "DOC: Clarify where to the additional arguments for some win_types"" This reverts commit 05ed0eb. * DOC: Remove whitespace in docstring * DOC: Remove indent of line934 * Update pandas/core/window/rolling.py Co-authored-by: Tom Augspurger <[email protected]>
1 parent 72aed3e commit 5d69786

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

pandas/core/window/rolling.py

+8-5
Original file line numberDiff line numberDiff line change
@@ -922,16 +922,19 @@ class Window(_Window):
922922
* ``blackmanharris``
923923
* ``nuttall``
924924
* ``barthann``
925-
* ``kaiser`` (needs beta)
926-
* ``gaussian`` (needs std)
927-
* ``general_gaussian`` (needs power, width)
928-
* ``slepian`` (needs width)
929-
* ``exponential`` (needs tau), center is set to None.
925+
* ``kaiser`` (needs parameter: beta)
926+
* ``gaussian`` (needs parameter: std)
927+
* ``general_gaussian`` (needs parameters: power, width)
928+
* ``slepian`` (needs parameter: width)
929+
* ``exponential`` (needs parameter: tau), center is set to None.
930930
931931
If ``win_type=None`` all points are evenly weighted. To learn more about
932932
different window types see `scipy.signal window functions
933933
<https://docs.scipy.org/doc/scipy/reference/signal.html#window-functions>`__.
934934
935+
Certain window types require additional parameters to be passed. Please see
936+
the third example below on how to add the additional parameters.
937+
935938
Examples
936939
--------
937940
>>> df = pd.DataFrame({'B': [0, 1, 2, np.nan, 4]})

0 commit comments

Comments
 (0)