docs(python): Update filter description to clarify that null evaluati…

…ons are removed (#16632)
pola-rs · Jun 1, 2024 · a9badd6 · a9badd6
1 parent 8710274
commit a9badd6
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/py-polars/polars/dataframe/frame.py b/py-polars/polars/dataframe/frame.py
@@ -4181,6 +4181,8 @@ def filter(
 
         The original order of the remaining rows is preserved.
 
+        Rows where the filter does not evaluate to True are discarded, including nulls.
+
         Parameters
         ----------
         predicates

diff --git a/py-polars/polars/expr/expr.py b/py-polars/polars/expr/expr.py
@@ -4560,6 +4560,9 @@ def filter(
 
         The original order of the remaining elements is preserved.
 
+        Elements where the filter does not evaluate to True are discarded, including
+        nulls.
+
         Mostly useful in an aggregation context. If you want to filter on a DataFrame
         level, use `LazyFrame.filter`.
 

diff --git a/py-polars/polars/lazyframe/frame.py b/py-polars/polars/lazyframe/frame.py
@@ -2865,6 +2865,8 @@ def filter(
 
         The original order of the remaining rows is preserved.
 
+        Rows where the filter does not evaluate to True are discarded, including nulls.
+
         Parameters
         ----------
         predicates

diff --git a/py-polars/polars/series/series.py b/py-polars/polars/series/series.py
@@ -3177,6 +3177,9 @@ def filter(self, predicate: Series | list[bool]) -> Self:
 
         The original order of the remaining elements is preserved.
 
+        Elements where the filter does not evaluate to True are discarded, including
+        nulls.
+
         Parameters
         ----------
         predicate