Merge pull request #194 from invenia/ed/filter-docstring

Clarify docstring for `Filter`
invenia · Feb 15, 2023 · 58a92c6 · 58a92c6
2 parents e398beb + 11f666e
commit 58a92c6
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/filters.jl b/src/filters.jl
@@ -2,7 +2,8 @@
     Filter
 
 A wrapper around a function that takes a log `Record` and returns
-a bool whether to skip logging it.
+a bool indicating whether to log it.
+`false` means "skip logging this record", similar to `Base.filter`. 
 
 # Fields
 `f::Function`: a function that should return a bool given a `Record`