Fix .diff() docstrings

pola-rs · Oct 21, 2023 · d6491b2 · d6491b2
1 parent 5e96abd
commit d6491b2
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py
@@ -7409,7 +7409,7 @@ def rank(
 
     def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Self:
         """
-        Calculate the n-th discrete difference.
+        Calculate the first discrete difference between shifted items.
 
         Parameters
         ----------

diff --git a/py-polars/polars/expr/list.py b/py-polars/polars/expr/list.py
@@ -664,7 +664,7 @@ def arg_max(self) -> Expr:
 
     def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Expr:
         """
-        Calculate the n-th discrete difference of every sublist.
+        Calculate the first discrete difference between shifted items of every sublist.
 
         Parameters
         ----------

diff --git a/py-polars/polars/series/list.py b/py-polars/polars/series/list.py
@@ -347,7 +347,7 @@ def arg_max(self) -> Series:
 
     def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Series:
         """
-        Calculate the n-th discrete difference of every sublist.
+        Calculate the first discrete difference between shifted items of every sublist.
 
         Parameters
         ----------

diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py
@@ -6003,7 +6003,7 @@ def rank(
 
     def diff(self, n: int = 1, null_behavior: NullBehavior = "ignore") -> Series:
         """
-        Calculate the n-th discrete difference.
+        Calculate the first discrete difference between shifted items.
 
         Parameters
         ----------