Docstring update

pola-rs · Oct 21, 2023 · 2656a32 · 2656a32
1 parent 9da2409
commit 2656a32
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
         ----------