Skip to content

Commit b34dbe8

Browse files
authored
DOC: Add windows.rst (#37575)
1 parent b00a17e commit b34dbe8

17 files changed

+636
-1019
lines changed

doc/source/reference/window.rst

+22-6
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ Rolling objects are returned by ``.rolling`` calls: :func:`pandas.DataFrame.roll
1010
Expanding objects are returned by ``.expanding`` calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc.
1111
ExponentialMovingWindow objects are returned by ``.ewm`` calls: :func:`pandas.DataFrame.ewm`, :func:`pandas.Series.ewm`, etc.
1212

13-
Standard moving window functions
14-
--------------------------------
13+
.. _api.functions_rolling:
14+
15+
Rolling window functions
16+
------------------------
1517
.. currentmodule:: pandas.core.window.rolling
1618

1719
.. autosummary::
@@ -33,15 +35,25 @@ Standard moving window functions
3335
Rolling.aggregate
3436
Rolling.quantile
3537
Rolling.sem
38+
39+
.. _api.functions_window:
40+
41+
Weighted window functions
42+
-------------------------
43+
.. currentmodule:: pandas.core.window.rolling
44+
45+
.. autosummary::
46+
:toctree: api/
47+
3648
Window.mean
3749
Window.sum
3850
Window.var
3951
Window.std
4052

4153
.. _api.functions_expanding:
4254

43-
Standard expanding window functions
44-
-----------------------------------
55+
Expanding window functions
56+
--------------------------
4557
.. currentmodule:: pandas.core.window.expanding
4658

4759
.. autosummary::
@@ -64,8 +76,10 @@ Standard expanding window functions
6476
Expanding.quantile
6577
Expanding.sem
6678

67-
Exponentially-weighted moving window functions
68-
----------------------------------------------
79+
.. _api.functions_ewm:
80+
81+
Exponentially-weighted window functions
82+
---------------------------------------
6983
.. currentmodule:: pandas.core.window.ewm
7084

7185
.. autosummary::
@@ -77,6 +91,8 @@ Exponentially-weighted moving window functions
7791
ExponentialMovingWindow.corr
7892
ExponentialMovingWindow.cov
7993

94+
.. _api.indexers_window:
95+
8096
Window indexer
8197
--------------
8298
.. currentmodule:: pandas

doc/source/user_guide/basics.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -538,8 +538,8 @@ standard deviation of 1), very concisely:
538538
539539
Note that methods like :meth:`~DataFrame.cumsum` and :meth:`~DataFrame.cumprod`
540540
preserve the location of ``NaN`` values. This is somewhat different from
541-
:meth:`~DataFrame.expanding` and :meth:`~DataFrame.rolling`.
542-
For more details please see :ref:`this note <stats.moments.expanding.note>`.
541+
:meth:`~DataFrame.expanding` and :meth:`~DataFrame.rolling` since ``NaN`` behavior
542+
is furthermore dictated by a ``min_periods`` parameter.
543543

544544
.. ipython:: python
545545
@@ -945,7 +945,7 @@ Aggregation API
945945

946946
The aggregation API allows one to express possibly multiple aggregation operations in a single concise way.
947947
This API is similar across pandas objects, see :ref:`groupby API <groupby.aggregate>`, the
948-
:ref:`window functions API <stats.aggregate>`, and the :ref:`resample API <timeseries.aggregate>`.
948+
:ref:`window API <window.overview>`, and the :ref:`resample API <timeseries.aggregate>`.
949949
The entry point for aggregation is :meth:`DataFrame.aggregate`, or the alias
950950
:meth:`DataFrame.agg`.
951951

0 commit comments

Comments
 (0)