doc: improve filter description

Velocidex · Aug 22, 2023 · aed26d8 · aed26d8
1 parent f265b96
commit aed26d8
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/references/vql.yaml b/docs/references/vql.yaml
@@ -1574,7 +1574,14 @@
   category: plugin
 - name: filter
   description: |
-    Filters a strings array by regex.
+    Filters an array by regex or condition.
+
+    ### Examples
+    ```vql
+    filter(list=["AA", "AB", "BA", "BB"], regex="^A") -> ["AA", "AB"]
+
+    filter(list=[1, 2, 3, 4, 5, 6], condition="x=>x > 3") -> [4, 5, 6]
+    ```
   type: Function
   args:
   - name: list