From 2656a32360e754a80f2d1bd357b113608b17352b Mon Sep 17 00:00:00 2001 From: Stijn de Gooijer Date: Sat, 21 Oct 2023 17:41:22 +0200 Subject: [PATCH] Docstring update --- py-polars/polars/expr/expr.py | 4 ++-- py-polars/polars/expr/list.py | 2 +- py-polars/polars/series/list.py | 2 +- py-polars/polars/series/series.py | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py index 13023ca5a248..a737d328e599 100644 --- a/py-polars/polars/expr/expr.py +++ b/py-polars/polars/expr/expr.py @@ -2354,7 +2354,7 @@ def take( @deprecate_renamed_parameter("periods", "n", version="0.19.11") def shift(self, n: int = 1) -> Self: """ - Shift the values by a given period. + Shift values by the given number of places. Parameters ---------- @@ -2388,7 +2388,7 @@ def shift_and_fill( n: int = 1, ) -> Self: """ - Shift the values by a given period and fill the resulting null values. + Shift values by the given number of places and fill the resulting null values. Parameters ---------- diff --git a/py-polars/polars/expr/list.py b/py-polars/polars/expr/list.py index 3fd23e52132b..1aca2964aaf4 100644 --- a/py-polars/polars/expr/list.py +++ b/py-polars/polars/expr/list.py @@ -718,7 +718,7 @@ def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Expr: @deprecate_renamed_parameter("periods", "n", version="0.19.11") def shift(self, n: int | IntoExprColumn = 1) -> Expr: """ - Shift values by the given period. + Shift values by the given number of places. Parameters ---------- diff --git a/py-polars/polars/series/list.py b/py-polars/polars/series/list.py index 3efff0a36bc0..a0546fa25e7d 100644 --- a/py-polars/polars/series/list.py +++ b/py-polars/polars/series/list.py @@ -391,7 +391,7 @@ def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Series: @deprecate_renamed_parameter("periods", "n", version="0.19.11") def shift(self, n: int | IntoExprColumn = 1) -> Series: """ - Shift values by the given period. + Shift values by the given number of places. Parameters ---------- diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py index c5a5f07e030f..388dcc81da97 100644 --- a/py-polars/polars/series/series.py +++ b/py-polars/polars/series/series.py @@ -5085,7 +5085,7 @@ def map_elements( @deprecate_renamed_parameter("periods", "n", version="0.19.11") def shift(self, n: int = 1) -> Series: """ - Shift the values by a given period. + Shift values by the given number of places. Parameters ---------- @@ -5122,7 +5122,7 @@ def shift_and_fill( n: int = 1, ) -> Series: """ - Shift the values by a given period and fill the resulting null values. + Shift values by the given number of places and fill the resulting null values. Parameters ----------