chore: Updates to find method docs. (#615)

chanzuckerberg · Apr 2, 2024 · bc266b6 · bc266b6
1 parent 5378bc3
commit bc266b6
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/client/python/cryoet_data_portal/src/cryoet_data_portal/_gql_base.py b/client/python/cryoet_data_portal/src/cryoet_data_portal/_gql_base.py
@@ -219,8 +219,16 @@ def find(
 
         Search filters are combined with *and* so all results will match all filters.
 
-        Expressions must be in the format:
+        Expressions with python-native operators (``==``, ``!=``, ``>``, ``>=``, ``<``, ``<=``) must be in the format:
             ``ModelSubclass.field`` ``{operator}`` ``{value}``
+        example:
+            ``Tomogram.voxel_spacing.run.name == "RUN1"``
+
+        Expressions with method operators (``like``, ``ilike``, ``_in``) must be in the format:
+            ``ModelSubclass.field.{operator}({value})``
+        examples:
+            ``Tomogram.voxel_spacing.run.name.like("%RUN1%")``
+            ``Tomogram.voxel_spacing.run.name._in(["RUN1", "RUN2"])``
 
         Supported operators are: ``==``, ``!=``, ``>``, ``>=``, ``<``, ``<=``, ``like``, ``ilike``, ``_in``