docs: highlight differences in median impl across backends

narwhals-dev · Oct 25, 2024 · a6b4089 · a6b4089
1 parent 80ecc0f
commit a6b4089
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/narwhals/expr.py b/narwhals/expr.py
@@ -451,6 +451,9 @@ def median(self) -> Self:
         """
         Get median value.
 
+        Notes:
+            Results might slightly differ across backends due to differences in the underlying algorithms used to compute the median.
+
         Examples:
             >>> import pandas as pd
             >>> import polars as pl
@@ -4595,8 +4598,9 @@ def median(*columns: str) -> Expr:
     """
     Get the median value.
 
-    Note:
-        Syntactic sugar for ``nw.col(columns).median()``
+    Notes:
+        - Syntactic sugar for ``nw.col(columns).median()``
+        - Results might slightly differ across backends due to differences in the underlying algorithms used to compute the median.
 
     Arguments:
         columns: Name(s) of the columns to use in the aggregation function

diff --git a/narwhals/series.py b/narwhals/series.py
@@ -525,6 +525,9 @@ def median(self) -> Any:
         """
         Reduce this Series to the median value.
 
+        Notes:
+            Results might slightly differ across backends due to differences in the underlying algorithms used to compute the median.
+
         Examples:
             >>> import pandas as pd
             >>> import polars as pl

diff --git a/narwhals/stable/v1/__init__.py b/narwhals/stable/v1/__init__.py
@@ -1361,8 +1361,9 @@ def median(*columns: str) -> Expr:
     """
     Get the median value.
 
-    Note:
-        Syntactic sugar for ``nw.col(columns).median()``
+    Notes:
+        - Syntactic sugar for ``nw.col(columns).median()``
+        - Results might slightly differ across backends due to differences in the underlying algorithms used to compute the median.
 
     Arguments:
         columns: Name(s) of the columns to use in the aggregation function