Skip to content

Commit a3e38ac

Browse files
authored
DOC: Clarify where to the additional arguments for some win_types
Edit: 711add5 First Commit Original issue: pandas-dev#34615
1 parent 711add5 commit a3e38ac

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,15 +922,18 @@ class Window(_Window):
922922
* ``blackmanharris``
923923
* ``nuttall``
924924
* ``barthann``
925-
* ``kaiser`` (needs beta in operation argument)
926-
* ``gaussian`` (needs std in operation argument)
927-
* ``general_gaussian`` (needs power, width in operation argument)
928-
* ``slepian`` (needs width in operation argument)
929-
* ``exponential`` (needs tau in operation argument), 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>`__.
934+
935+
Certain window types require a scale parameter to be passed. Please see the third example below
936+
on how to add the additional parameters.
934937
935938
Examples
936939
--------

0 commit comments

Comments
 (0)