Skip to content

Commit

Permalink
chore: docs formatting fixes (#616)
Browse files Browse the repository at this point in the history
  • Loading branch information
jgadling committed Apr 3, 2024
1 parent bc266b6 commit 958b553
Showing 1 changed file with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -221,14 +221,14 @@ def find(
Expressions with python-native operators (``==``, ``!=``, ``>``, ``>=``, ``<``, ``<=``) must be in the format:
``ModelSubclass.field`` ``{operator}`` ``{value}``
example:
``Tomogram.voxel_spacing.run.name == "RUN1"``
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"])``
Examples:
- ``Tomogram.voxel_spacing.run.name.like("%RUN1%")``
- ``Tomogram.voxel_spacing.run.name._in(["RUN1", "RUN2"])``
Supported operators are: ``==``, ``!=``, ``>``, ``>=``, ``<``, ``<=``, ``like``, ``ilike``, ``_in``
Expand All @@ -255,6 +255,7 @@ def find(
Filter runs by attributes, including attributes in related models:
>>> runs = Run.find(client, query_filters=[Run.name == "TS_026", Run.dataset.id == 10000])
>>> runs = Run.find(client, query_filters=[Run.name._in(['TS_026', 'TS_027']), Run.tomogram_voxel_spacings.annotations.object_name.ilike('%membrane%')])
Get all results for this type:
Expand Down

0 comments on commit 958b553

Please sign in to comment.