diff --git a/cognite/client/data_classes/filters.py b/cognite/client/data_classes/filters.py index c6d9bdcb3b..3e6b886c85 100644 --- a/cognite/client/data_classes/filters.py +++ b/cognite/client/data_classes/filters.py @@ -513,7 +513,7 @@ class Equals(FilterWithPropertyAndValue): Example: - Retrieve all instances where the property value equals 42: + Filter than can be used to retrieve items where the property value equals 42: >>> from cognite.client.data_classes.filters import Equals >>> filter = Equals(("some", "property"), 42) @@ -532,7 +532,7 @@ class In(FilterWithPropertyAndValueList): Example: - Retrieve all instances where the property value equals 42 or 43: + Filter than can be used to retrieve items where the property value equals 42 or 43 (or both): >>> from cognite.client.data_classes.filters import In >>> filter = In(("some", "property"), [42, 43]) @@ -550,7 +550,7 @@ class Exists(FilterWithProperty): Example: - Retrieve all instances where the property value is set: + Filter than can be used to retrieve items where the property value is set: >>> from cognite.client.data_classes.filters import Exists >>> filter = Exists(("some", "property")) @@ -569,7 +569,7 @@ class Prefix(FilterWithPropertyAndValue): Example: - Retrieve all instances where the property value starts with "somePrefix": + Filter than can be used to retrieve items where the property value starts with "somePrefix": >>> from cognite.client.data_classes.filters import Prefix >>> filter = Prefix(("some", "property"), "somePrefix") @@ -588,7 +588,7 @@ class ContainsAny(FilterWithPropertyAndValueList): Example: - Retrieve all instances where the property value contains either 42 or 43: + Filter than can be used to retrieve items where the property value contains either 42 or 43: >>> from cognite.client.data_classes.filters import ContainsAny >>> filter = ContainsAny(("some", "property"), [42, 43]) @@ -607,7 +607,7 @@ class ContainsAll(FilterWithPropertyAndValueList): Example: - Retrieve all instances where the property value contains both 42 and 43: + Filter than can be used to retrieve items where the property value contains both 42 and 43: >>> from cognite.client.data_classes.filters import ContainsAll >>> filter = ContainsAll(("some", "property"), [42, 43]) diff --git a/docs/source/filters.rst b/docs/source/filters.rst index 30c3fe45b0..3da9f1f329 100644 --- a/docs/source/filters.rst +++ b/docs/source/filters.rst @@ -103,7 +103,8 @@ The `Prefix` filter checks if a string property starts with a specified prefix. Range ^^^^^ -The `Range` filter checks if a numeric property's value is within a specified range. +The `Range` filter checks if a numeric property's value is within a specified range that can be +open-ended. .. autoclass:: cognite.client.data_classes.filters.Range :members: @@ -163,7 +164,7 @@ Data Modeling-Specific Filters ------------------------------ HasData ^^^^^^^ -The `HasData` filter checks if an item has data for a given property. +The `HasData` filter checks if an instance has data for a given property. .. autoclass:: cognite.client.data_classes.filters.HasData :members: @@ -171,7 +172,7 @@ The `HasData` filter checks if an item has data for a given property. MatchAll ^^^^^^^^ -The `MatchAll` filter combines multiple sub-filters using a logical AND operation. +The `MatchAll` filter matches all instances. .. autoclass:: cognite.client.data_classes.filters.MatchAll :members: @@ -179,7 +180,7 @@ The `MatchAll` filter combines multiple sub-filters using a logical AND operatio Nested ^^^^^^ -The `Nested` filter applies a filter to a nested property. +The `Nested` filter applies a filter to the node pointed to by a direct relation property. .. autoclass:: cognite.client.data_classes.filters.Nested :members: