From 04b00e613a04f1f8f16d238d7330dd666c4d448d Mon Sep 17 00:00:00 2001 From: Henry Harbeck <59268910+henryharbeck@users.noreply.github.com> Date: Tue, 16 Apr 2024 23:36:56 +1000 Subject: [PATCH] docs(python): Align docstring phrasing in `Series/Expr.dt.truncate/round` (#15698) Co-authored-by: Henry Harbeck --- py-polars/polars/expr/datetime.py | 10 +++++----- py-polars/polars/series/datetime.py | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/py-polars/polars/expr/datetime.py b/py-polars/polars/expr/datetime.py index 09767c386a1e..4400fd21ef1b 100644 --- a/py-polars/polars/expr/datetime.py +++ b/py-polars/polars/expr/datetime.py @@ -202,7 +202,7 @@ def truncate( - `'latest'`: use the latest datetime .. deprecated:: 0.19.3 - This is now auto-inferred, you can safely remove this argument. + This is now automatically inferred; you can safely omit this argument. Notes ----- @@ -321,12 +321,12 @@ def truncate( if use_earliest is not None: issue_deprecation_warning( - "`use_earliest` is deprecated. It is now auto-inferred, you can safely remove this argument.", + "`use_earliest` is deprecated. It is now automatically inferred; you can safely omit this argument.", version="0.19.13", ) if ambiguous is not None: issue_deprecation_warning( - "`ambiguous` is deprecated. It is now auto-inferred, you can safely remove this argument.", + "`ambiguous` is deprecated. It is now automatically inferred; you can safely omit this argument.", version="0.19.13", ) every = parse_as_expression(every, str_as_lit=True) @@ -383,7 +383,7 @@ def round( - `'latest'`: use the latest datetime .. deprecated:: 0.19.3 - This is now auto-inferred, you can safely remove this argument. + This is now automatically inferred; you can safely omit this argument. Returns ------- @@ -478,7 +478,7 @@ def round( if ambiguous is not None: issue_deprecation_warning( - "`ambiguous` is deprecated. It is now auto-inferred, you can safely remove this argument.", + "`ambiguous` is deprecated. It is now automatically inferred; you can safely omit this argument.", version="0.19.13", ) diff --git a/py-polars/polars/series/datetime.py b/py-polars/polars/series/datetime.py index a74f8c52b5ce..ccae74ad7037 100644 --- a/py-polars/polars/series/datetime.py +++ b/py-polars/polars/series/datetime.py @@ -1703,7 +1703,7 @@ def truncate( - `'latest'`: use the latest datetime .. deprecated:: 0.19.3 - This is now auto-inferred, you can safely remove this argument. + This is now automatically inferred; you can safely omit this argument. Notes ----- @@ -1845,7 +1845,7 @@ def round( - `'latest'`: use the latest datetime .. deprecated:: 0.19.3 - This is now auto-inferred, you can safely remove this argument. + This is now automatically inferred; you can safely omit this argument. Returns -------