diff --git a/altair/vegalite/v5/api.py b/altair/vegalite/v5/api.py index 6eb6b7d63..115fe7e3c 100644 --- a/altair/vegalite/v5/api.py +++ b/altair/vegalite/v5/api.py @@ -543,11 +543,18 @@ def check_fields_and_encodings(parameter: Parameter, field_name: str) -> bool: _FieldEqualType: TypeAlias = Union["IntoExpression", Parameter, SchemaBase] -"""Permitted types for equality checks on field values: +""" +Permitted types for equality checks on field values. + +Applies to the following context(s): + + import altair as alt -- `datum.field == ...` -- `FieldEqualPredicate(equal=...)` -- `when(**constraints=...)` + alt.datum.field == ... + alt.FieldEqualPredicate(field="field", equal=...) + alt.when(field=...) + alt.when().then().when(field=...) + alt.Chart.transform_filter(field=...) """