Skip to content

Commit c6fc6d0

Browse files
DOC: Closed parameter not intuitively documented in DataFrame.rolling (#60832)
* change docs * format * format
1 parent 3bd27ff commit c6fc6d0

File tree

2 files changed

+24
-10
lines changed

2 files changed

+24
-10
lines changed

pandas/core/groupby/groupby.py

+12-5
Original file line numberDiff line numberDiff line change
@@ -3717,14 +3717,21 @@ def rolling(
37173717
an integer index is not used to calculate the rolling window.
37183718
37193719
closed : str, default None
3720-
If ``'right'``, the first point in the window is excluded from calculations.
3720+
Determines the inclusivity of points in the window
3721+
If ``'right'``, (First, Last] the last point in the window
3722+
is included in the calculations.
37213723
3722-
If ``'left'``, the last point in the window is excluded from calculations.
3724+
If ``'left'``, [First, Last) the first point in the window
3725+
is included in the calculations.
37233726
3724-
If ``'both'``, no points in the window are excluded from calculations.
3727+
If ``'both'``, [First, Last] all points in the window
3728+
are included in the calculations.
37253729
3726-
If ``'neither'``, the first and last points in the window are excluded
3727-
from calculations.
3730+
If ``'neither'``, (First, Last) the first and last points
3731+
in the window are excludedfrom calculations.
3732+
3733+
() and [] are referencing open and closed set
3734+
notation respetively.
37283735
37293736
Default ``None`` (``'right'``).
37303737

pandas/core/window/rolling.py

+12-5
Original file line numberDiff line numberDiff line change
@@ -929,14 +929,21 @@ class Window(BaseWindow):
929929
an integer index is not used to calculate the rolling window.
930930
931931
closed : str, default None
932-
If ``'right'``, the first point in the window is excluded from calculations.
932+
Determines the inclusivity of points in the window
933+
If ``'right'``, (First, Last] the last point in the window
934+
is included in the calculations.
933935
934-
If ``'left'``, the last point in the window is excluded from calculations.
936+
If ``'left'``, [First, Last) the first point in the window
937+
is included in the calculations.
935938
936-
If ``'both'``, no point in the window is excluded from calculations.
939+
If ``'both'``, [First, Last] all points in the window
940+
are included in the calculations.
937941
938-
If ``'neither'``, the first and last points in the window are excluded
939-
from calculations.
942+
If ``'neither'``, (First, Last) the first and last points
943+
in the window are excludedfrom calculations.
944+
945+
() and [] are referencing open and closed set
946+
notation respetively.
940947
941948
Default ``None`` (``'right'``).
942949

0 commit comments

Comments
 (0)