Skip to content

Commit dba6895

Browse files
dstansbyTomAugspurger
authored andcommitted
DOC: clarify default window in rolling method (#18177)
(cherry picked from commit c40c8f8)
1 parent d48579b commit dba6895

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
@@ -346,7 +346,9 @@ The following methods are available:
346346
:meth:`~Window.sum`, Sum of values
347347
:meth:`~Window.mean`, Mean of values
348348

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

351353
- ``boxcar``
352354
- ``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)