Skip to content

Commit b2ff8ce

Browse files
authored
chore: Release 5.5.0 (#3699)
* update RELEASING.md: - Remove redundant tag step - Explicitly checkout main and check working tree - Normalize indentation of CLI commands * Add expression docstring links to expr class docstring so sphinx finds them * Add raw_enabled for :raw-html: directive * Add Generic link * format * update user guide with link * fix raw-html render * bump version to 5.5.0 * expand urls * Fix _continuous uniform probability distribution URL
1 parent b6481d2 commit b2ff8ce

File tree

10 files changed

+232
-68
lines changed

10 files changed

+232
-68
lines changed

RELEASING.md

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,26 @@
22
Remove any existing environments managed by `hatch` so that it will create new ones
33
with the latest dependencies when executing the commands further below:
44

5-
hatch env prune
5+
hatch env prune
66

7-
2. Make certain your branch is in sync with head. If you work on a fork, replace `origin` with `upstream`:
7+
2. Make certain your branch is in sync with head, and that you have no uncommitted modifications. If you work on a fork, replace `origin` with `upstream`:
88

9-
git pull origin main
9+
git checkout main
10+
git pull origin main
11+
git status # Should show "nothing to commit, working tree clean"
1012

1113
3. Do a clean doc build:
1214

13-
hatch run doc:clean-all
14-
hatch run doc:build-html
15-
hatch run doc:serve
15+
hatch run doc:clean-all
16+
hatch run doc:build-html
17+
hatch run doc:serve
1618

1719
Navigate to http://localhost:8000 and ensure it looks OK (particularly
1820
do a visual scan of the gallery thumbnails).
1921

2022
4. Create a new release branch:
2123

22-
git switch -c version_5.0.0
24+
git switch -c version_5.0.0
2325

2426
5. Update version to, e.g. 5.0.0:
2527

@@ -28,56 +30,51 @@
2830

2931
6. Commit changes and push:
3032

31-
git add . -u
32-
git commit -m "chore: Bump version to 5.0.0"
33-
git push
33+
git add . -u
34+
git commit -m "chore: Bump version to 5.0.0"
35+
git push
3436

3537
7. Merge release branch into main, make sure that all required checks pass
3638

37-
8. Tag the release:
38-
39-
git tag -a v5.0.0 -m "version 5.0.0 release"
40-
git push origin v5.0.0
41-
42-
9. On main, build source & wheel distributions. If you work on a fork, replace `origin` with `upstream`:
39+
8. On main, build source & wheel distributions. If you work on a fork, replace `origin` with `upstream`:
4340

44-
git switch main
45-
git pull origin main
46-
hatch clean # clean old builds & distributions
47-
hatch build # create a source distribution and universal wheel
41+
git switch main
42+
git pull origin main
43+
hatch clean # clean old builds & distributions
44+
hatch build # create a source distribution and universal wheel
4845

49-
10. publish to PyPI (Requires correct PyPI owner permissions):
46+
9. publish to PyPI (Requires correct PyPI owner permissions):
5047

5148
hatch publish
5249

53-
11. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
50+
10. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
5451

5552
hatch run doc:publish-clean-build
5653

57-
12. On main, tag the release. If you work on a fork, replace `origin` with `upstream`:
54+
11. On main, tag the release. If you work on a fork, replace `origin` with `upstream`:
5855

59-
git tag -a v5.0.0 -m "Version 5.0.0 release"
60-
git push origin v5.0.0
56+
git tag -a v5.0.0 -m "Version 5.0.0 release"
57+
git push origin v5.0.0
6158

62-
13. Create a new branch:
59+
12. Create a new branch:
6360

6461
git switch -c maint_5.1.0dev
6562

66-
14. Update version and add 'dev' suffix, e.g. 5.1.0dev:
63+
13. Update version and add 'dev' suffix, e.g. 5.1.0dev:
6764

6865
- in ``altair/__init__.py``
6966
- in ``doc/conf.py``
7067

71-
15. Commit changes and push:
68+
14. Commit changes and push:
7269

7370
git add . -u
7471
git commit -m "chore: Bump version to 5.1.0dev"
7572
git push
7673
77-
16. Merge maintenance branch into main
74+
15. Merge maintenance branch into main
7875

79-
17. Double-check that a conda-forge pull request is generated from the updated
76+
16. Double-check that a conda-forge pull request is generated from the updated
8077
pip package by the conda-forge bot (may take up to several hours):
8178
https://github.com/conda-forge/altair-feedstock/pulls
8279

83-
18. Publish a new release in https://github.com/vega/altair/releases/
80+
17. Publish a new release in https://github.com/vega/altair/releases/

altair/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ruff: noqa
2-
__version__ = "5.5.0dev"
2+
__version__ = "5.5.0"
33

44
# The content of __all__ is automatically written by
55
# tools/update_init_file.py. Do not modify directly.

altair/expr/__init__.py

Lines changed: 111 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,115 @@ class expr(_ExprRef, metaclass=_ExprMeta):
117117
}))},
118118
shorthand: 'yval'
119119
})
120+
121+
.. _Number.isNaN:
122+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isNan
123+
.. _Number.isFinite:
124+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isFinite
125+
.. _Math.abs:
126+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/abs
127+
.. _Math.acos:
128+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/acos
129+
.. _Math.asin:
130+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/asin
131+
.. _Math.atan:
132+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atan
133+
.. _Math.atan2:
134+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/atan2
135+
.. _Math.ceil:
136+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/ceil
137+
.. _Math.cos:
138+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/cos
139+
.. _Math.exp:
140+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/exp
141+
.. _Math.floor:
142+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/floor
143+
.. _Math.hypot:
144+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/hypot
145+
.. _Math.log:
146+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/log
147+
.. _Math.max:
148+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/max
149+
.. _Math.min:
150+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/min
151+
.. _Math.pow:
152+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/pow
153+
.. _Math.random:
154+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random
155+
.. _Math.round:
156+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/round
157+
.. _Math.sin:
158+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sin
159+
.. _Math.sqrt:
160+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sqrt
161+
.. _Math.tan:
162+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/tan
163+
.. _normal (Gaussian) probability distribution:
164+
https://en.wikipedia.org/wiki/Normal_distribution
165+
.. _cumulative distribution function:
166+
https://en.wikipedia.org/wiki/Cumulative_distribution_function
167+
.. _probability density function:
168+
https://en.wikipedia.org/wiki/Probability_density_function
169+
.. _log-normal probability distribution:
170+
https://en.wikipedia.org/wiki/Log-normal_distribution
171+
.. _continuous uniform probability distribution:
172+
https://en.wikipedia.org/wiki/Continuous_uniform_distribution
173+
.. _*unit*:
174+
https://vega.github.io/vega/docs/api/time/#time-units
175+
.. _JavaScript's String.replace:
176+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace
177+
.. _d3-format specifier:
178+
https://github.com/d3/d3-format/
179+
.. _*units*:
180+
https://vega.github.io/vega/docs/api/time/#time-units
181+
.. _timeUnitSpecifier API documentation:
182+
https://vega.github.io/vega/docs/api/time/#timeUnitSpecifier
183+
.. _timeFormat:
184+
https://vega.github.io/vega/docs/expressions/#timeFormat
185+
.. _utcFormat:
186+
https://vega.github.io/vega/docs/expressions/#utcFormat
187+
.. _d3-time-format specifier:
188+
https://github.com/d3/d3-time-format/
189+
.. _TimeMultiFormat object:
190+
https://vega.github.io/vega/docs/types/#TimeMultiFormat
191+
.. _UTC:
192+
https://en.wikipedia.org/wiki/Coordinated_Universal_Time
193+
.. _JavaScript's RegExp:
194+
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
195+
.. _RGB:
196+
https://en.wikipedia.org/wiki/RGB_color_model
197+
.. _d3-color's rgb function:
198+
https://github.com/d3/d3-color#rgb
199+
.. _HSL:
200+
https://en.wikipedia.org/wiki/HSL_and_HSV
201+
.. _d3-color's hsl function:
202+
https://github.com/d3/d3-color#hsl
203+
.. _CIE LAB:
204+
https://en.wikipedia.org/wiki/Lab_color_space#CIELAB
205+
.. _d3-color's lab function:
206+
https://github.com/d3/d3-color#lab
207+
.. _HCL:
208+
https://en.wikipedia.org/wiki/Lab_color_space#CIELAB
209+
.. _d3-color's hcl function:
210+
https://github.com/d3/d3-color#hcl
211+
.. _W3C Web Content Accessibility Guidelines:
212+
https://www.w3.org/TR/2008/REC-WCAG20-20081211/#contrast-ratiodef
213+
.. _continuous color scheme:
214+
https://vega.github.io/vega/docs/schemes
215+
.. _geoArea:
216+
https://github.com/d3/d3-geo#geoArea
217+
.. _path.area:
218+
https://github.com/d3/d3-geo#path_area
219+
.. _geoBounds:
220+
https://github.com/d3/d3-geo#geoBounds
221+
.. _path.bounds:
222+
https://github.com/d3/d3-geo#path_bounds
223+
.. _geoCentroid:
224+
https://github.com/d3/d3-geo#geoCentroid
225+
.. _path.centroid:
226+
https://github.com/d3/d3-geo#path_centroid
227+
.. _window.screen:
228+
https://developer.mozilla.org/en-US/docs/Web/API/Window/screen
120229
"""
121230

122231
@override
@@ -643,13 +752,13 @@ def sampleUniform(
643752
cls, min: IntoExpression = None, max: IntoExpression = None, /
644753
) -> Expression:
645754
"""
646-
Returns a sample from a univariate `continuous uniform probability distribution`_) over the interval [``min``, ``max``).
755+
Returns a sample from a univariate `continuous uniform probability distribution`_ over the interval [``min``, ``max``).
647756
648757
If unspecified, ``min`` defaults to ``0`` and ``max`` defaults to ``1``. If only one
649758
argument is provided, it is interpreted as the ``max`` value.
650759
651760
.. _continuous uniform probability distribution:
652-
https://en.wikipedia.org/wiki/Uniform_distribution_(continuous
761+
https://en.wikipedia.org/wiki/Continuous_uniform_distribution
653762
"""
654763
return FunctionExpression("sampleUniform", (min, max))
655764

altair/vegalite/v5/schema/channels.py

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8308,8 +8308,8 @@ class Radius(FieldChannelMixin, core.PositionFieldDefBase):
83088308
stacked bar and area charts
83098309
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
83108310
`with percentage tooltip
8311-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
8312-
-``"center"`` - stacking with center baseline (for `streamgraph
8311+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
8312+
* ``"center"`` - stacking with center baseline (for `streamgraph
83138313
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
83148314
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
83158315
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -8644,8 +8644,8 @@ class RadiusDatum(DatumChannelMixin, core.PositionDatumDefBase):
86448644
stacked bar and area charts
86458645
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
86468646
`with percentage tooltip
8647-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
8648-
-``"center"`` - stacking with center baseline (for `streamgraph
8647+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
8648+
* ``"center"`` - stacking with center baseline (for `streamgraph
86498649
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
86508650
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
86518651
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -15197,8 +15197,8 @@ class Theta(FieldChannelMixin, core.PositionFieldDefBase):
1519715197
stacked bar and area charts
1519815198
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1519915199
`with percentage tooltip
15200-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15201-
-``"center"`` - stacking with center baseline (for `streamgraph
15200+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15201+
* ``"center"`` - stacking with center baseline (for `streamgraph
1520215202
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1520315203
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1520415204
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -15529,8 +15529,8 @@ class ThetaDatum(DatumChannelMixin, core.PositionDatumDefBase):
1552915529
stacked bar and area charts
1553015530
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1553115531
`with percentage tooltip
15532-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15533-
-``"center"`` - stacking with center baseline (for `streamgraph
15532+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15533+
* ``"center"`` - stacking with center baseline (for `streamgraph
1553415534
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1553515535
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1553615536
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -17067,8 +17067,8 @@ class X(FieldChannelMixin, core.PositionFieldDef):
1706717067
stacked bar and area charts
1706817068
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1706917069
`with percentage tooltip
17070-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
17071-
-``"center"`` - stacking with center baseline (for `streamgraph
17070+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
17071+
* ``"center"`` - stacking with center baseline (for `streamgraph
1707217072
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1707317073
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1707417074
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -17550,8 +17550,8 @@ class XDatum(DatumChannelMixin, core.PositionDatumDef):
1755017550
stacked bar and area charts
1755117551
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1755217552
`with percentage tooltip
17553-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
17554-
-``"center"`` - stacking with center baseline (for `streamgraph
17553+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
17554+
* ``"center"`` - stacking with center baseline (for `streamgraph
1755517555
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1755617556
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1755717557
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -19306,8 +19306,8 @@ class Y(FieldChannelMixin, core.PositionFieldDef):
1930619306
stacked bar and area charts
1930719307
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1930819308
`with percentage tooltip
19309-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
19310-
-``"center"`` - stacking with center baseline (for `streamgraph
19309+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
19310+
* ``"center"`` - stacking with center baseline (for `streamgraph
1931119311
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1931219312
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1931319313
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -19789,8 +19789,8 @@ class YDatum(DatumChannelMixin, core.PositionDatumDef):
1978919789
stacked bar and area charts
1979019790
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1979119791
`with percentage tooltip
19792-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
19793-
-``"center"`` - stacking with center baseline (for `streamgraph
19792+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
19793+
* ``"center"`` - stacking with center baseline (for `streamgraph
1979419794
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1979519795
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1979619796
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area

altair/vegalite/v5/schema/core.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15216,8 +15216,8 @@ class PositionDatumDefBase(PolarDef):
1521615216
stacked bar and area charts
1521715217
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1521815218
`with percentage tooltip
15219-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15220-
-``"center"`` - stacking with center baseline (for `streamgraph
15219+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15220+
* ``"center"`` - stacking with center baseline (for `streamgraph
1522115221
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1522215222
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1522315223
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -15410,8 +15410,8 @@ class PositionDatumDef(PositionDef):
1541015410
stacked bar and area charts
1541115411
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1541215412
`with percentage tooltip
15413-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15414-
-``"center"`` - stacking with center baseline (for `streamgraph
15413+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15414+
* ``"center"`` - stacking with center baseline (for `streamgraph
1541515415
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1541615416
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1541715417
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -15681,8 +15681,8 @@ class PositionFieldDef(PositionDef):
1568115681
stacked bar and area charts
1568215682
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1568315683
`with percentage tooltip
15684-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15685-
-``"center"`` - stacking with center baseline (for `streamgraph
15684+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15685+
* ``"center"`` - stacking with center baseline (for `streamgraph
1568615686
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1568715687
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1568815688
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area
@@ -15963,8 +15963,8 @@ class PositionFieldDefBase(PolarDef):
1596315963
stacked bar and area charts
1596415964
<https://vega.github.io/vega-lite/docs/stack.html#normalized>`__ and pie charts
1596515965
`with percentage tooltip
15966-
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__). :raw-html:`<br/>`
15967-
-``"center"`` - stacking with center baseline (for `streamgraph
15966+
<https://vega.github.io/vega-lite/docs/arc.html#tooltip>`__).
15967+
* ``"center"`` - stacking with center baseline (for `streamgraph
1596815968
<https://vega.github.io/vega-lite/docs/stack.html#streamgraph>`__).
1596915969
* ``null`` or ``false`` - No-stacking. This will produce layered `bar
1597015970
<https://vega.github.io/vega-lite/docs/stack.html#layered-bar-chart>`__ and area

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
# built documents.
8080
#
8181
# The short X.Y version.
82-
version = "5.5.0dev"
82+
version = "5.5.0"
8383
# The full version, including alpha/beta/rc tags.
8484
release = f"{version}"
8585

doc/user_guide/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -791,3 +791,5 @@ Typing
791791
Optional
792792
is_chart_type
793793

794+
.. _Generic:
795+
https://typing.readthedocs.io/en/latest/spec/generics.html#generics

0 commit comments

Comments
 (0)