Skip to content

Commit 1f6c1b3

Browse files
authored
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: pandas-dev#34593
1 parent ef8567d commit 1f6c1b3

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pandas/core/window/rolling.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -922,11 +922,11 @@ 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 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.
930930
931931
If ``win_type=None`` all points are evenly weighted. To learn more about
932932
different window types see `scipy.signal window functions

0 commit comments

Comments
 (0)