Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: docs formatting fixes #616

Merged
merged 1 commit into from
Apr 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading