Skip to content

Commit 537f4a7

Browse files
authored
release summary for 2024.02.0 (#8764)
* move author names to a separate line * style fixes * first attempt at a summary * add contributors * move entry to the right place * more style * reflow * remove additional indentation * point intersphinx to the new home of cubed * add flox to intersphinx * [skip-ci]
1 parent ff0d056 commit 537f4a7

File tree

2 files changed

+56
-48
lines changed

2 files changed

+56
-48
lines changed

doc/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,9 +327,10 @@
327327
"cftime": ("https://unidata.github.io/cftime", None),
328328
"sparse": ("https://sparse.pydata.org/en/latest/", None),
329329
"hypothesis": ("https://hypothesis.readthedocs.io/en/latest/", None),
330-
"cubed": ("https://tom-e-white.com/cubed/", None),
330+
"cubed": ("https://cubed-dev.github.io/cubed/", None),
331331
"datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),
332332
"xarray-tutorial": ("https://tutorial.xarray.dev/", None),
333+
"flox": ("https://flox.readthedocs.io/en/latest/", None),
333334
# "opt_einsum": ("https://dgasmith.github.io/opt_einsum/", None),
334335
}
335336

doc/whats-new.rst

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -20,90 +20,100 @@ What's New
2020
v2024.02.0 (unreleased)
2121
-----------------------
2222

23+
This release brings size information to the text ``repr``, changes to the accepted frequency
24+
strings, and various bug fixes.
25+
26+
Thanks to our 12 contributors:
27+
28+
Anderson Banihirwe, Deepak Cherian, Eivind Jahren, Etienne Schalk, Justus Magin, Marco Wolsza,
29+
Mathias Hauser, Matt Savoie, Maximilian Roos, Rambaud Pierrick, Tom Nicholas
30+
2331
New Features
2432
~~~~~~~~~~~~
2533

26-
- Added a simple `nbytes` representation in DataArrays and Dataset `repr`.
34+
- Added a simple ``nbytes`` representation in DataArrays and Dataset ``repr``.
2735
(:issue:`8690`, :pull:`8702`).
2836
By `Etienne Schalk <https://github.com/etienneschalk>`_.
29-
- Allow negative frequency strings (e.g. ``"-1YE"``). These strings are for example used
30-
in :py:func:`date_range`, and :py:func:`cftime_range` (:pull:`8651`).
37+
- Allow negative frequency strings (e.g. ``"-1YE"``). These strings are for example used in
38+
:py:func:`date_range`, and :py:func:`cftime_range` (:pull:`8651`).
3139
By `Mathias Hauser <https://github.com/mathause>`_.
32-
- Add :py:meth:`NamedArray.expand_dims`, :py:meth:`NamedArray.permute_dims` and :py:meth:`NamedArray.broadcast_to`
33-
(:pull:`8380`) By `Anderson Banihirwe <https://github.com/andersy005>`_.
34-
- Xarray now defers to flox's `heuristics <https://flox.readthedocs.io/en/latest/implementation.html#heuristics>`_
35-
to set default `method` for groupby problems. This only applies to ``flox>=0.9``.
40+
- Add :py:meth:`NamedArray.expand_dims`, :py:meth:`NamedArray.permute_dims` and
41+
:py:meth:`NamedArray.broadcast_to` (:pull:`8380`)
42+
By `Anderson Banihirwe <https://github.com/andersy005>`_.
43+
- Xarray now defers to `flox's heuristics <https://flox.readthedocs.io/en/latest/implementation.html#heuristics>`_
44+
to set the default `method` for groupby problems. This only applies to ``flox>=0.9``.
3645
By `Deepak Cherian <https://github.com/dcherian>`_.
3746
- All `quantile` methods (e.g. :py:meth:`DataArray.quantile`) now use `numbagg`
3847
for the calculation of nanquantiles (i.e., `skipna=True`) if it is installed.
3948
This is currently limited to the linear interpolation method (`method='linear'`).
40-
(:issue:`7377`, :pull:`8684`) By `Marco Wolsza <https://github.com/maawoo>`_.
49+
(:issue:`7377`, :pull:`8684`)
50+
By `Marco Wolsza <https://github.com/maawoo>`_.
4151

4252
Breaking changes
4353
~~~~~~~~~~~~~~~~
4454

4555
- :py:func:`infer_freq` always returns the frequency strings as defined in pandas 2.2
46-
(:issue:`8612`, :pull:`8627`). By `Mathias Hauser <https://github.com/mathause>`_.
56+
(:issue:`8612`, :pull:`8627`).
57+
By `Mathias Hauser <https://github.com/mathause>`_.
4758

4859
Deprecations
4960
~~~~~~~~~~~~
50-
- The `dt.weekday_name` parameter wasn't functional on modern pandas versions and has been removed. (:issue:`8610`, :pull:`8664`)
61+
- The `dt.weekday_name` parameter wasn't functional on modern pandas versions and has been
62+
removed. (:issue:`8610`, :pull:`8664`)
5163
By `Sam Coleman <https://github.com/nameloCmaS>`_.
5264

5365

5466
Bug fixes
5567
~~~~~~~~~
5668

57-
- Fixed a regression that prevented multi-index level coordinates being
58-
serialized after resetting or dropping the multi-index (:issue:`8628`, :pull:`8672`).
69+
- Fixed a regression that prevented multi-index level coordinates being serialized after resetting
70+
or dropping the multi-index (:issue:`8628`, :pull:`8672`).
5971
By `Benoit Bovy <https://github.com/benbovy>`_.
6072
- Fix bug with broadcasting when wrapping array API-compliant classes. (:issue:`8665`, :pull:`8669`)
6173
By `Tom Nicholas <https://github.com/TomNicholas>`_.
62-
- Ensure :py:meth:`DataArray.unstack` works when wrapping array API-compliant classes. (:issue:`8666`, :pull:`8668`)
74+
- Ensure :py:meth:`DataArray.unstack` works when wrapping array API-compliant
75+
classes. (:issue:`8666`, :pull:`8668`)
6376
By `Tom Nicholas <https://github.com/TomNicholas>`_.
6477
- Fix negative slicing of Zarr arrays without dask installed. (:issue:`8252`)
6578
By `Deepak Cherian <https://github.com/dcherian>`_.
66-
- Preserve chunks when writing time-like variables to zarr by enabling lazy CF
67-
encoding of time-like variables (:issue:`7132`, :issue:`8230`, :issue:`8432`,
68-
:pull:`8575`). By `Spencer Clark <https://github.com/spencerkclark>`_ and
69-
`Mattia Almansi <https://github.com/malmans2>`_.
70-
- Preserve chunks when writing time-like variables to zarr by enabling their
71-
lazy encoding (:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8253`,
72-
:pull:`8575`; see also discussion in :pull:`8253`). By `Spencer Clark
73-
<https://github.com/spencerkclark>`_ and `Mattia Almansi
74-
<https://github.com/malmans2>`_.
75-
- Raise an informative error if dtype encoding of time-like variables would
76-
lead to integer overflow or unsafe conversion from floating point to integer
77-
values (:issue:`8542`, :pull:`8575`). By `Spencer Clark
78-
<https://github.com/spencerkclark>`_.
79-
- Raise an error when unstacking a MultiIndex that has duplicates as this would lead
80-
to silent data loss (:issue:`7104`, :pull:`8737`). By `Mathias Hauser <https://github.com/mathause>`_.
79+
- Preserve chunks when writing time-like variables to zarr by enabling lazy CF encoding of time-like
80+
variables (:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8575`).
81+
By `Spencer Clark <https://github.com/spencerkclark>`_ and `Mattia Almansi <https://github.com/malmans2>`_.
82+
- Preserve chunks when writing time-like variables to zarr by enabling their lazy encoding
83+
(:issue:`7132`, :issue:`8230`, :issue:`8432`, :pull:`8253`, :pull:`8575`; see also discussion in
84+
:pull:`8253`).
85+
By `Spencer Clark <https://github.com/spencerkclark>`_ and `Mattia Almansi <https://github.com/malmans2>`_.
86+
- Raise an informative error if dtype encoding of time-like variables would lead to integer overflow
87+
or unsafe conversion from floating point to integer values (:issue:`8542`, :pull:`8575`).
88+
By `Spencer Clark <https://github.com/spencerkclark>`_.
89+
- Raise an error when unstacking a MultiIndex that has duplicates as this would lead to silent data
90+
loss (:issue:`7104`, :pull:`8737`).
91+
By `Mathias Hauser <https://github.com/mathause>`_.
8192

8293
Documentation
8394
~~~~~~~~~~~~~
84-
- Fix `variables` arg typo in `Dataset.sortby()` docstring
85-
(:issue:`8663`, :pull:`8670`)
95+
- Fix `variables` arg typo in `Dataset.sortby()` docstring (:issue:`8663`, :pull:`8670`)
8696
By `Tom Vo <https://github.com/tomvothecoder>`_.
97+
- Fixed documentation where the use of the depreciated pandas frequency string prevented the
98+
documentation from being built. (:pull:`8638`)
99+
By `Sam Coleman <https://github.com/nameloCmaS>`_.
87100

88101
Internal Changes
89102
~~~~~~~~~~~~~~~~
90103

91-
- ``DataArray.dt`` now raises an ``AttributeError`` rather than a ``TypeError``
92-
when the data isn't datetime-like. (:issue:`8718`, :pull:`8724`)
104+
- ``DataArray.dt`` now raises an ``AttributeError`` rather than a ``TypeError`` when the data isn't
105+
datetime-like. (:issue:`8718`, :pull:`8724`)
93106
By `Maximilian Roos <https://github.com/max-sixty>`_.
94-
95-
- Move ``parallelcompat`` and ``chunk managers`` modules from ``xarray/core`` to ``xarray/namedarray``. (:pull:`8319`)
107+
- Move ``parallelcompat`` and ``chunk managers`` modules from ``xarray/core`` to
108+
``xarray/namedarray``. (:pull:`8319`)
96109
By `Tom Nicholas <https://github.com/TomNicholas>`_ and `Anderson Banihirwe <https://github.com/andersy005>`_.
97-
98-
- Imports ``datatree`` repository and history into internal
99-
location. (:pull:`8688`) By `Matt Savoie <https://github.com/flamingbear>`_
100-
and `Justus Magin <https://github.com/keewis>`_.
101-
102-
- Adds :py:func:`open_datatree` into ``xarray/backends`` (:pull:`8697`) By `Matt
103-
Savoie <https://github.com/flamingbear>`_.
104-
105-
- Refactor :py:meth:`xarray.core.indexing.DaskIndexingAdapter.__getitem__` to remove an unnecessary rewrite of the indexer key
106-
(:issue: `8377`, :pull:`8758`) By `Anderson Banihirwe <https://github.com/andersy005>`
110+
- Imports ``datatree`` repository and history into internal location. (:pull:`8688`)
111+
By `Matt Savoie <https://github.com/flamingbear>`_ and `Justus Magin <https://github.com/keewis>`_.
112+
- Adds :py:func:`open_datatree` into ``xarray/backends`` (:pull:`8697`)
113+
By `Matt Savoie <https://github.com/flamingbear>`_.
114+
- Refactor :py:meth:`xarray.core.indexing.DaskIndexingAdapter.__getitem__` to remove an unnecessary
115+
rewrite of the indexer key (:issue: `8377`, :pull:`8758`)
116+
By `Anderson Banihirwe <https://github.com/andersy005>`_.
107117

108118
.. _whats-new.2024.01.1:
109119

@@ -134,9 +144,6 @@ Documentation
134144

135145
- Pin ``sphinx-book-theme`` to ``1.0.1`` to fix a rendering issue with the sidebar in the docs. (:issue:`8619`, :pull:`8632`)
136146
By `Tom Nicholas <https://github.com/TomNicholas>`_.
137-
- Fixed documentation where the use of the depreciated pandas frequency string
138-
prevented the documentation from being built. (:pull:`8638`)
139-
By `Sam Coleman <https://github.com/nameloCmaS>`_.
140147

141148
.. _whats-new.2024.01.0:
142149

0 commit comments

Comments
 (0)