Skip to content

Commit 7fce53d

Browse files
authored
fix: Resolve multiple sphinx warnings (#3787)
1 parent d8b2270 commit 7fce53d

File tree

8 files changed

+82
-78
lines changed

8 files changed

+82
-78
lines changed

altair/vegalite/v5/schema/_config.py

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,11 @@ class AreaConfigKwds(TypedDict, total=False):
140140
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
141141
value can be used.
142142
143-
__Default value:__ ``"source-over"``
143+
**Default value:** ``"source-over"``
144144
color
145145
Default color.
146146
147-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
148-
``"#4682b4"``
147+
**Default value:** ``"#4682b4"``
149148
150149
**Note:**
151150
@@ -842,7 +841,7 @@ class AxisConfigKwds(TypedDict, total=False):
842841
and ``config.style.foo`` (the specified style ``"foo"`` has higher precedence).
843842
tickBand
844843
For band scales, indicates if ticks and grid lines should be placed at the
845-
``"center"`` of a band (default) or at the band ``"extent"``s to indicate intervals
844+
``"center"`` of a band (default) or at the band extents to indicate intervals
846845
tickCap
847846
The stroke cap for the tick lines' ending style. One of ``"butt"``, ``"round"`` or
848847
``"square"``.
@@ -1125,12 +1124,11 @@ class BarConfigKwds(TypedDict, total=False):
11251124
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
11261125
value can be used.
11271126
1128-
__Default value:__ ``"source-over"``
1127+
**Default value:** ``"source-over"``
11291128
color
11301129
Default color.
11311130
1132-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
1133-
``"#4682b4"``
1131+
**Default value:** ``"#4682b4"``
11341132
11351133
**Note:**
11361134
@@ -3457,12 +3455,11 @@ class LineConfigKwds(TypedDict, total=False):
34573455
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
34583456
value can be used.
34593457
3460-
__Default value:__ ``"source-over"``
3458+
**Default value:** ``"source-over"``
34613459
color
34623460
Default color.
34633461
3464-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
3465-
``"#4682b4"``
3462+
**Default value:** ``"#4682b4"``
34663463
34673464
**Note:**
34683465
@@ -3995,12 +3992,11 @@ class MarkConfigKwds(TypedDict, total=False):
39953992
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
39963993
value can be used.
39973994
3998-
__Default value:__ ``"source-over"``
3995+
**Default value:** ``"source-over"``
39993996
color
40003997
Default color.
40013998
4002-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
4003-
``"#4682b4"``
3999+
**Default value:** ``"#4682b4"``
40044000
40054001
**Note:**
40064002
@@ -4571,14 +4567,13 @@ class OverlayMarkDefKwds(TypedDict, total=False):
45714567
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
45724568
value can be used.
45734569
4574-
__Default value:__ ``"source-over"``
4570+
**Default value:** ``"source-over"``
45754571
clip
45764572
Whether a mark be clipped to the enclosing group's width and height.
45774573
color
45784574
Default color.
45794575
4580-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
4581-
``"#4682b4"``
4576+
**Default value:** ``"#4682b4"``
45824577
45834578
**Note:**
45844579
@@ -5713,12 +5708,11 @@ class RectConfigKwds(TypedDict, total=False):
57135708
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
57145709
value can be used.
57155710
5716-
__Default value:__ ``"source-over"``
5711+
**Default value:** ``"source-over"``
57175712
color
57185713
Default color.
57195714
5720-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
5721-
``"#4682b4"``
5715+
**Default value:** ``"#4682b4"``
57225716
57235717
**Note:**
57245718
@@ -6637,12 +6631,11 @@ class TickConfigKwds(TypedDict, total=False):
66376631
mix-blend-mode <https://developer.mozilla.org/en-US/docs/Web/CSS/mix-blend-mode>`__
66386632
value can be used.
66396633
6640-
__Default value:__ ``"source-over"``
6634+
**Default value:** ``"source-over"``
66416635
color
66426636
Default color.
66436637
6644-
**Default value:** :raw-html:`<span style="color: #4682b4;">` ■ :raw-html:`</span>`
6645-
``"#4682b4"``
6638+
**Default value:** ``"#4682b4"``
66466639
66476640
**Note:**
66486641

altair/vegalite/v5/schema/_typing.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@ class Value(TypedDict, Generic[T]):
128128
value: T
129129
Wrapped value.
130130
131+
Returns
132+
-------
133+
dict
134+
131135
.. _Generic:
132136
https://typing.readthedocs.io/en/latest/spec/generics.html#generics
133137
"""
@@ -180,6 +184,10 @@ class RowColKwds(TypedDict, Generic[T], total=False):
180184
column: T
181185
row: T
182186
187+
Returns
188+
-------
189+
dict
190+
183191
.. _Generic:
184192
https://typing.readthedocs.io/en/latest/spec/generics.html#generics
185193
"""

altair/vegalite/v5/schema/channels.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21618,8 +21618,8 @@ def encode(
2161821618
original order in the data sources.
2161921619
* Otherwise, this ``order`` channel encodes layer order of the marks.
2162021620

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

21885-
**Note**: In aggregate plots, ``order`` field should be ``aggregate``d to avoid
21886-
creating additional aggregation grouping.
21885+
**Note**: In aggregate plots, ``order`` field should be aggregated to avoid creating
21886+
additional aggregation grouping.
2188721887
radius
2188821888
The outer radius in pixels of arc marks.
2188921889
radius2

0 commit comments

Comments
 (0)