Update filter docs, Fixes #3460 (#3461)

* Update filter docs * Apply suggestions from code review --------- Co-authored-by: Bogumił Kamiński <[email protected]>
JuliaData · Sep 7, 2024 · 97bbb40 · 97bbb40
1 parent bb63361
commit 97bbb40
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/abstractdataframe/abstractdataframe.jl b/src/abstractdataframe/abstractdataframe.jl
@@ -1151,6 +1151,11 @@ data frames.
     function instead as it is consistent with other DataFrames.jl functions
     (as opposed to `filter`).
 
+!!! note
+
+    Due to type stability the `filter(cols => fun, df::AbstractDataFrame; view::Bool=false)`
+    call is preferred in performance critical applications.
+
 $METADATA_FIXED
 
 See also: [`filter!`](@ref)
@@ -1281,6 +1286,11 @@ data frames.
     function instead as it is consistent with other DataFrames.jl functions
     (as opposed to `filter!`).
 
+!!! note
+
+    Due to type stability the `filter!(cols => fun, df::AbstractDataFrame)`
+    call is preferred in performance critical applications.
+
 $METADATA_FIXED
 
 See also: [`filter`](@ref)