Skip to content

Commit

Permalink
fix: Resolve multiple sphinx warnings (#3787)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dangotbanned
dangotbanned authored Feb 3, 2025
1 parent d8b2270 commit 7fce53d
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 78 deletions.
37 changes: 15 additions & 22 deletions altair/vegalite/v5/schema/_config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,11 @@ class AreaConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -842,7 +841,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 Expand Up @@ -1125,12 +1124,11 @@ class BarConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -3457,12 +3455,11 @@ class LineConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -3995,12 +3992,11 @@ class MarkConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -4571,14 +4567,13 @@ class OverlayMarkDefKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
clip
Whether a mark be clipped to the enclosing group's width and height.
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -5713,12 +5708,11 @@ class RectConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down Expand Up @@ -6637,12 +6631,11 @@ class TickConfigKwds(TypedDict, total=False):
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
value can be used.
__Default value:__ ``"source-over"``
**Default value:** ``"source-over"``
color
Default color.
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
``"#4682b4"``
**Default value:** ``"#4682b4"``
**Note:**
Expand Down
8 changes: 8 additions & 0 deletions altair/vegalite/v5/schema/_typing.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ class Value(TypedDict, Generic[T]):
value: T
Wrapped value.
Returns
-------
dict
.. _Generic:
https://typing.readthedocs.io/en/latest/spec/generics.html#generics
"""
Expand Down Expand Up @@ -180,6 +184,10 @@ class RowColKwds(TypedDict, Generic[T], total=False):
column: T
row: T
Returns
-------
dict
.. _Generic:
https://typing.readthedocs.io/en/latest/spec/generics.html#generics
"""
Expand Down
8 changes: 4 additions & 4 deletions altair/vegalite/v5/schema/channels.py
View file
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
Loading

0 comments on commit 7fce53d

Please sign in to comment.