Some updates to docs #1534
Some updates to docs #1534
Conversation
erlendvollset
force-pushed
the
fix-filter-docs
branch
from
f18e269 to
ff2ebcc
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #1534 +/- ##
=======================================
Coverage 91.83% 91.83%
=======================================
Files 120 120
Lines 15591 15591
=======================================
Hits 14318 14318
Misses 1273 1273
|
erlendvollset
force-pushed
the
fix-filter-docs
branch
from
813325d to
2dc0edb
Compare
Feature data modeling instead of assets, as this is the functionality we want new users to relate to.
Time Series and geospatial have 4 sub resources, sequences has 2, so it makes more sense to group them like this
erlendvollset
force-pushed
the
fix-filter-docs
branch
from
0367692 to
d440014
Compare
| _filter_name = "or" | ||
|
|
||
|
|
||
| @final | ||
| class Not(CompoundFilter): | ||
| """A filter that negates another filter. |
There was a problem hiding this comment.
| """A filter that negates another filter. | |
| """A filter that negates another filter recursively. |
There was a problem hiding this comment.
Not sure about that. It makes it sound like it negates each of the underlying filters recursively, which would be difficult to reason about if it was the case.
| gt (FilterValue | None): Greater than. | ||
| gte (FilterValue | None): Greater than or equal to. | ||
| lt (FilterValue | None): Less than. | ||
| lte (FilterValue | None): Less than or equal to. |
There was a problem hiding this comment.
Just noticed that these type hints using FilterValue are wrong/misleading as only a subset is supported (other misleading uses: Overlaps and Prefix):
(RangeValue (RangeValue (string) or RangeValue (number) or RangeValue (integer))) or ReferencedPropertyValueV3 (object) (FilterValueRange)
@dataclass
class PropertyReferenceValue:
property: PropertyReference
@dataclass
class ParameterValue:
parameter: str
FilterValue: TypeAlias = Union[RawValue, PropertyReferenceValue, ParameterValue]
RawValue: TypeAlias = Union[str, float, bool, Sequence, Mapping[str, Any], Label]There was a problem hiding this comment.
Yeah, not ideal. Will leave some validation for runtime. But not gonna address that in this PR.
(TY ChatGPT) 🙏