depr(python): Make some parameters of dt.add_business_days keyword-…

…only (#19428)
pola-rs · Oct 24, 2024 · a08b513 · a08b513
1 parent 1452468
commit a08b513
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/py-polars/polars/expr/datetime.py b/py-polars/polars/expr/datetime.py
@@ -6,7 +6,7 @@
 import polars._reexport as pl
 from polars import functions as F
 from polars._utils.convert import parse_as_duration_string
-from polars._utils.deprecation import deprecate_function
+from polars._utils.deprecation import deprecate_function, deprecate_nonkeyword_arguments
 from polars._utils.parse import parse_into_expression
 from polars._utils.unstable import unstable
 from polars._utils.wrap import wrap_expr
@@ -35,6 +35,7 @@ class ExprDateTimeNameSpace:
     def __init__(self, expr: Expr) -> None:
         self._pyexpr = expr._pyexpr
 
+    @deprecate_nonkeyword_arguments(allowed_args=["self", "n"], version="1.12.0")
     def add_business_days(
         self,
         n: int | IntoExpr,
@@ -97,7 +98,9 @@ def add_business_days(
         You can pass a custom weekend - for example, if you only take Sunday off:
 
         >>> week_mask = (True, True, True, True, True, True, False)
-        >>> df.with_columns(result=pl.col("start").dt.add_business_days(5, week_mask))
+        >>> df.with_columns(
+        ...     result=pl.col("start").dt.add_business_days(5, week_mask=week_mask)
+        ... )
         shape: (2, 2)
         ┌────────────┬────────────┐
         │ start      ┆ result     │

diff --git a/py-polars/polars/series/datetime.py b/py-polars/polars/series/datetime.py
@@ -97,7 +97,7 @@ def add_business_days(
         You can pass a custom weekend - for example, if you only take Sunday off:
 
         >>> week_mask = (True, True, True, True, True, True, False)
-        >>> s.dt.add_business_days(5, week_mask)
+        >>> s.dt.add_business_days(5, week_mask=week_mask)
         shape: (2,)
         Series: 'start' [date]
         [