docs(python): Clarify docstrings for closed argument

py-polars/polars/internals/dataframe/frame.py

@@ -96,7 +96,7 @@
     from polars.internals.type_aliases import (
         AsofJoinStrategy,
         AvroCompression,
-        ClosedWindow,
+        ClosedInterval,
         ComparisonOperator,
         CsvEncoding,
         FillNullStrategy,
@@ -3347,7 +3347,7 @@ def groupby_rolling(
         *,
         period: str | timedelta,
         offset: str | timedelta | None = None,
-        closed: ClosedWindow = "right",
+        closed: ClosedInterval = "right",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
     ) -> RollingGroupBy[DF]:
         """
@@ -3398,7 +3398,7 @@ def groupby_rolling(
         offset
             offset of the window. Default is -period
         closed : {'right', 'left', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
         by
             Also group by this column/these columns
 
@@ -3456,7 +3456,7 @@ def groupby_dynamic(
         offset: str | timedelta | None = None,
         truncate: bool = True,
         include_boundaries: bool = False,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
         start_by: StartBy = "window",
     ) -> DynamicGroupBy[DF]:
@@ -3521,8 +3521,8 @@ def groupby_dynamic(
             Add the lower and upper bound of the window to the "_lower_bound" and
             "_upper_bound" columns. This will impact performance because it's harder to
             parallelize
-        closed : {'right', 'left', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+        closed : {'left', 'right', 'both', 'none'}
+            Define which sides of the temporal interval are closed (inclusive).
         by
             Also group by this column/these columns
         start_by : {'window', 'datapoint', 'monday'}

py-polars/polars/internals/dataframe/groupby.py

@@ -10,7 +10,7 @@
 
 if TYPE_CHECKING:
     from polars.internals.type_aliases import (
-        ClosedWindow,
+        ClosedInterval,
         RollingInterpolationMethod,
         StartBy,
     )
@@ -736,7 +736,7 @@ def __init__(
         index_column: str,
         period: str | timedelta,
         offset: str | timedelta | None,
-        closed: ClosedWindow = "none",
+        closed: ClosedInterval = "none",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
     ):
         period = _timedelta_to_pl_duration(period)
@@ -781,7 +781,7 @@ def __init__(
         offset: str | timedelta | None,
         truncate: bool = True,
         include_boundaries: bool = True,
-        closed: ClosedWindow = "none",
+        closed: ClosedInterval = "none",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
         start_by: StartBy = "window",
     ):

py-polars/polars/internals/expr/expr.py

@@ -35,7 +35,7 @@
 
 if TYPE_CHECKING:
     from polars.internals.type_aliases import (
-        ClosedWindow,
+        ClosedInterval,
         FillNullStrategy,
         InterpolationMethod,
         NullBehavior,
@@ -3412,7 +3412,7 @@ def is_between(
         start: Expr | datetime | date | int | float,
         end: Expr | datetime | date | int | float,
         include_bounds: bool | tuple[bool, bool] | None = None,
-        closed: ClosedWindow | None = None,
+        closed: ClosedInterval | None = None,
     ) -> Expr:
         """
         Check if this expression is between start and end.
@@ -3433,7 +3433,7 @@ def is_between(
             - (False, True):   Exclude start and include end.
             - (True, False):   Include start and exclude end.
         closed : {'none', 'left', 'right', 'both'}
-            Define whether the interval is closed or not. Defaults to 'none'.
+            Define which sides of the interval are closed (inclusive).
 
         Returns
         -------
@@ -3708,7 +3708,7 @@ def rolling_min(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Apply a rolling min (moving min) over the values in this array.
@@ -3750,7 +3750,7 @@ def rolling_min(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -3804,7 +3804,7 @@ def rolling_max(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Apply a rolling max (moving max) over the values in this array.
@@ -3846,7 +3846,7 @@ def rolling_max(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -3900,7 +3900,7 @@ def rolling_mean(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Apply a rolling mean (moving mean) over the values in this array.
@@ -3942,7 +3942,7 @@ def rolling_mean(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -3994,7 +3994,7 @@ def rolling_sum(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Apply a rolling sum (moving sum) over the values in this array.
@@ -4036,7 +4036,7 @@ def rolling_sum(
             set the column that will be used to determine the windows. This column must
             of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -4090,7 +4090,7 @@ def rolling_std(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Compute a rolling standard deviation.
@@ -4132,7 +4132,7 @@ def rolling_std(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -4186,7 +4186,7 @@ def rolling_var(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Compute a rolling variance.
@@ -4228,7 +4228,7 @@ def rolling_var(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -4282,7 +4282,7 @@ def rolling_median(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Compute a rolling median.
@@ -4320,7 +4320,7 @@ def rolling_median(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------
@@ -4376,7 +4376,7 @@ def rolling_quantile(
         min_periods: int | None = None,
         center: bool = False,
         by: str | None = None,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
     ) -> Expr:
         """
         Compute a rolling quantile.
@@ -4418,7 +4418,7 @@ def rolling_quantile(
             set the column that will be used to determine the windows. This column must
             be of dtype `{Date, Datetime}`
         closed : {'left', 'right', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
 
         Warnings
         --------

py-polars/polars/internals/functions.py

@@ -30,7 +30,7 @@
     _DOCUMENTING = True
 
 if TYPE_CHECKING:
-    from polars.internals.type_aliases import ClosedWindow, ConcatMethod, TimeUnit
+    from polars.internals.type_aliases import ClosedInterval, ConcatMethod, TimeUnit
 
 
 def get_dummies(
@@ -277,7 +277,7 @@ def date_range(
     interval: str | timedelta,
     *,
     lazy: Literal[False] = ...,
-    closed: ClosedWindow = "both",
+    closed: ClosedInterval = "both",
     name: str | None = None,
     time_unit: TimeUnit | None = None,
     time_zone: str | None = None,
@@ -292,7 +292,7 @@ def date_range(
     interval: str | timedelta,
     *,
     lazy: Literal[False] = ...,
-    closed: ClosedWindow = "both",
+    closed: ClosedInterval = "both",
     name: str | None = None,
     time_unit: TimeUnit | None = None,
     time_zone: str | None = None,
@@ -307,7 +307,7 @@ def date_range(
     interval: str | timedelta,
     *,
     lazy: Literal[False] = ...,
-    closed: ClosedWindow = "both",
+    closed: ClosedInterval = "both",
     name: str | None = None,
     time_unit: TimeUnit | None = None,
     time_zone: str | None = None,
@@ -322,7 +322,7 @@ def date_range(
     interval: str | timedelta,
     *,
     lazy: Literal[True],
-    closed: ClosedWindow = "both",
+    closed: ClosedInterval = "both",
     name: str | None = None,
     time_unit: TimeUnit | None = None,
     time_zone: str | None = None,
@@ -337,7 +337,7 @@ def date_range(
     interval: str | timedelta,
     *,
     lazy: bool = False,
-    closed: ClosedWindow = "both",
+    closed: ClosedInterval = "both",
     name: str | None = None,
     time_unit: TimeUnit | None = None,
     time_zone: str | None = None,

py-polars/polars/internals/lazyframe/frame.py

@@ -67,7 +67,7 @@
 if TYPE_CHECKING:
     from polars.internals.type_aliases import (
         AsofJoinStrategy,
-        ClosedWindow,
+        ClosedInterval,
         CsvEncoding,
         FillNullStrategy,
         JoinStrategy,
@@ -1646,7 +1646,7 @@ def groupby_rolling(
         *,
         period: str | timedelta,
         offset: str | timedelta | None = None,
-        closed: ClosedWindow = "right",
+        closed: ClosedInterval = "right",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
     ) -> LazyGroupBy[LDF]:
         """
@@ -1697,7 +1697,7 @@ def groupby_rolling(
         offset
             offset of the window. Default is -period
         closed : {'right', 'left', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
         by
             Also group by this column/these columns
 
@@ -1765,7 +1765,7 @@ def groupby_dynamic(
         offset: str | timedelta | None = None,
         truncate: bool = True,
         include_boundaries: bool = False,
-        closed: ClosedWindow = "left",
+        closed: ClosedInterval = "left",
         by: str | Sequence[str] | pli.Expr | Sequence[pli.Expr] | None = None,
         start_by: StartBy = "window",
     ) -> LazyGroupBy[LDF]:
@@ -1831,7 +1831,7 @@ def groupby_dynamic(
             "_upper_bound" columns. This will impact performance because it's harder to
             parallelize
         closed : {'right', 'left', 'both', 'none'}
-            Define whether the temporal window interval is closed or not.
+            Define which sides of the temporal interval are closed (inclusive).
         by
             Also group by this column/these columns
         start_by : {'window', 'datapoint', 'monday'}

py-polars/polars/internals/type_aliases.py

@@ -21,7 +21,6 @@
 # The following all have an equivalent Rust enum with the same name
 AvroCompression: TypeAlias = Literal["uncompressed", "snappy", "deflate"]
 CategoricalOrdering: TypeAlias = Literal["physical", "lexical"]
-ClosedWindow: TypeAlias = Literal["left", "right", "both", "none"]
 StartBy: TypeAlias = Literal["window", "datapoint", "monday"]
 CsvEncoding: TypeAlias = Literal["utf8", "utf8-lossy"]
 FillNullStrategy: TypeAlias = Literal[
@@ -56,6 +55,7 @@
 
 # The following have a Rust enum equivalent with a different name
 AsofJoinStrategy: TypeAlias = Literal["backward", "forward"]  # AsofStrategy
+ClosedInterval: TypeAlias = Literal["left", "right", "both", "none"]  # ClosedWindow
 RollingInterpolationMethod: TypeAlias = Literal[
     "nearest", "higher", "lower", "midpoint", "linear"
 ]  # QuantileInterpolOptions

py-polars/tests/unit/test_rolling.py

@@ -10,7 +10,7 @@
 from polars.testing import assert_frame_equal
 
 if TYPE_CHECKING:
-    from polars.internals.type_aliases import ClosedWindow
+    from polars.internals.type_aliases import ClosedInterval
 
 
 def test_rolling_kernels_and_groupby_rolling() -> None:
@@ -35,9 +35,8 @@ def test_rolling_kernels_and_groupby_rolling() -> None:
         timedelta(days=2),
         timedelta(days=3),
     ]:
-        closed_windows: list[ClosedWindow] = ["left", "right", "none", "both"]
+        closed_windows: list[ClosedInterval] = ["left", "right", "none", "both"]
         for closed in closed_windows:
-
             out1 = df.select(
                 [
                     pl.col("dt"),