Merge pull request #122 from snopoke/snopoke-patch-1

Filter doc updates
h2non · May 10, 2023 · 8c1e1f5 · 8c1e1f5
2 parents fefc4dd + 11fbd38
commit 8c1e1f5
Showing 1 changed file with 13 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -203,9 +203,19 @@ Extensions
 |              | - ``$.objects[\\some_field,/other_field]``    |
 +--------------+-----------------------------------------------+
 | filter       | - ``$.objects[?(@some_field > 5)]``           |
-|              | - ``$.objects[?some_field = "foobar")]``      |
-|              | - ``$.objects[?some_field =~ "foobar")]``     |
-|              | - ``$.objects[?some_field > 5 & other < 2)]`` |
+|              | - ``$.objects[?some_field = "foobar"]``       |
+|              | - ``$.objects[?some_field =~ "foobar"]``      |
+|              | - ``$.objects[?some_field > 5 & other < 2]``  |
+|              |                                               |
+|              | Supported operators:                          |
+|              | - Equality: ==, =, !=                         |
+|              | - Comparison: >, >=, <, <=                    |
+|              | - Regex match: =~                             |
+|              |                                               |
+|              | Combine multiple criteria with '&'.           |
+|              |                                               |
+|              | Properties can only be compared to static     |
+|              | values.                                       |
 +--------------+-----------------------------------------------+
 | arithmetic   | - ``$.foo + "_" + $.bar``                     |
 | (-+*/)       | - ``$.foo * 12``                              |