Skip to content

Commit

Permalink
fix: 8x WARNING: Inline literal start-string without end-string. [doc…
Browse files Browse the repository at this point in the history
…utils]

Encoding, SharedEncoding, FacetedEncoding, EncodeKwds, LegendConfig, LegendConfigKwds
  • Loading branch information
dangotbanned committed Feb 3, 2025
1 parent 2433b82 commit 6525473
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 13 deletions.
2 changes: 1 addition & 1 deletion altair/vegalite/v5/schema/_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ class AxisConfigKwds(TypedDict, total=False):
and ``config.style.foo`` (the specified style ``"foo"`` has higher precedence).
tickBand
For band scales, indicates if ticks and grid lines should be placed at the
``"center"`` of a band (default) or at the band ``"extent"``s to indicate intervals
``"center"`` of a band (default) or at the band extents to indicate intervals
tickCap
The stroke cap for the tick lines' ending style. One of ``"butt"``, ``"round"`` or
``"square"``.
Expand Down
8 changes: 4 additions & 4 deletions altair/vegalite/v5/schema/channels.py
Original file line number Diff line number Diff line change
Expand Up @@ -21618,8 +21618,8 @@ def encode(
original order in the data sources.
* Otherwise, this ``order`` channel encodes layer order of the marks.

**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to
avoid creating additional aggregation grouping.
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid
creating additional aggregation grouping.
radius : str, :class:`Radius`, Dict, :class:`RadiusDatum`, :class:`RadiusValue`
The outer radius in pixels of arc marks.
radius2 : str, :class:`Radius2`, Dict, :class:`Radius2Datum`, :class:`Radius2Value`
Expand Down Expand Up @@ -21882,8 +21882,8 @@ class EncodeKwds(TypedDict, total=False):
the data sources.
* Otherwise, this ``order`` channel encodes layer order of the marks.

**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to avoid
creating additional aggregation grouping.
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid creating
additional aggregation grouping.
radius
The outer radius in pixels of arc marks.
radius2
Expand Down
16 changes: 8 additions & 8 deletions altair/vegalite/v5/schema/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -1480,7 +1480,7 @@ class Axis(VegaLiteSchema):
and ``config.style.foo`` (the specified style ``"foo"`` has higher precedence).
tickBand : dict, :class:`ExprRef`, Literal['center', 'extent']
For band scales, indicates if ticks and grid lines should be placed at the
``"center"`` of a band (default) or at the band ``"extent"``s to indicate intervals
``"center"`` of a band (default) or at the band extents to indicate intervals
tickCap : dict, :class:`ExprRef`, :class:`StrokeCap`, Literal['butt', 'round', 'square']
The stroke cap for the tick lines' ending style. One of ``"butt"``, ``"round"`` or
``"square"``.
Expand Down Expand Up @@ -2056,7 +2056,7 @@ class AxisConfig(VegaLiteSchema):
and ``config.style.foo`` (the specified style ``"foo"`` has higher precedence).
tickBand : dict, :class:`ExprRef`, Literal['center', 'extent']
For band scales, indicates if ticks and grid lines should be placed at the
``"center"`` of a band (default) or at the band ``"extent"``s to indicate intervals
``"center"`` of a band (default) or at the band extents to indicate intervals
tickCap : dict, :class:`ExprRef`, :class:`StrokeCap`, Literal['butt', 'round', 'square']
The stroke cap for the tick lines' ending style. One of ``"butt"``, ``"round"`` or
``"square"``.
Expand Down Expand Up @@ -5787,8 +5787,8 @@ class Encoding(VegaLiteSchema):
the data sources.
* Otherwise, this ``order`` channel encodes layer order of the marks.

**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to avoid
creating additional aggregation grouping.
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid creating
additional aggregation grouping.
radius : dict, :class:`PolarDef`, :class:`PositionValueDef`, :class:`PositionDatumDefBase`, :class:`PositionFieldDefBase`
The outer radius in pixels of arc marks.
radius2 : dict, :class:`DatumDef`, :class:`Position2Def`, :class:`PositionValueDef`, :class:`SecondaryFieldDef`
Expand Down Expand Up @@ -6959,8 +6959,8 @@ class FacetedEncoding(VegaLiteSchema):
the data sources.
* Otherwise, this ``order`` channel encodes layer order of the marks.

**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to avoid
creating additional aggregation grouping.
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid creating
additional aggregation grouping.
radius : dict, :class:`PolarDef`, :class:`PositionValueDef`, :class:`PositionDatumDefBase`, :class:`PositionFieldDefBase`
The outer radius in pixels of arc marks.
radius2 : dict, :class:`DatumDef`, :class:`Position2Def`, :class:`PositionValueDef`, :class:`SecondaryFieldDef`
Expand Down Expand Up @@ -20650,8 +20650,8 @@ class SharedEncoding(VegaLiteSchema):
the data sources.
* Otherwise, this ``order`` channel encodes layer order of the marks.

**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to avoid
creating additional aggregation grouping.
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid creating
additional aggregation grouping.
radius : dict

radius2 : dict
Expand Down
5 changes: 5 additions & 0 deletions tools/markup.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ def __call__(self, s: str) -> str:
description = description.replace("’", "'") # noqa: RUF001 [RIGHT SINGLE QUOTATION MARK]
description = description.replace("–", "-") # noqa: RUF001 [EN DASH]
description = description.replace(" ", " ") # noqa: RUF001 [NO-BREAK SPACE]

# Fixing `codespan` followed by a non-whitespace character
description = description.replace("``aggregate``d", "aggregated").replace(
'``"extent"``s', "extents"
)
return description.strip()


Expand Down

0 comments on commit 6525473

Please sign in to comment.