Skip to content

Commit c40c8f8

Browse files
dstansbyjorisvandenbossche
authored andcommitted
DOC: clarify default window in rolling method (#18177)
1 parent a47ad56 commit c40c8f8

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

doc/source/computation.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,9 @@ The following methods are available:
344344
:meth:`~Window.sum`, Sum of values
345345
:meth:`~Window.mean`, Mean of values
346346

347-
The weights used in the window are specified by the ``win_type`` keyword. The list of recognized types are:
347+
The weights used in the window are specified by the ``win_type`` keyword.
348+
The list of recognized types are the `scipy.signal window functions
349+
<https://docs.scipy.org/doc/scipy/reference/signal.html#window-functions>`__:
348350

349351
- ``boxcar``
350352
- ``triang``

pandas/core/window.py

+3
Original file line numberDiff line numberDiff line change
@@ -503,6 +503,9 @@ class Window(_Window):
503503
* ``general_gaussian`` (needs power, width)
504504
* ``slepian`` (needs width).
505505
506+
If ``win_type=None`` all points are evenly weighted. To learn more about
507+
different window types see `scipy.signal window functions
508+
<https://docs.scipy.org/doc/scipy/reference/signal.html#window-functions>`__.
506509
"""
507510

508511
def validate(self):

0 commit comments

Comments
 (0)