Skip to content

Commit 01c1d25

Browse files
authored
more maintenance on whats-new.rst (#5272)
* move names to a separate line * fix a few broken links * [skip-ci]
1 parent eec2b59 commit 01c1d25

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

doc/whats-new.rst

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,19 +41,21 @@ New Features
4141
- Add :py:meth:`Dataset.to_pandas` (:pull:`5247`)
4242
By `Giacomo Caria <https://github.com/gcaria>`_.
4343
- Add :py:meth:`DataArray.plot.surface` which wraps matplotlib's `plot_surface` to make
44-
surface plots (:issue:`#2235` :issue:`#5084` :pull:`5101`).
44+
surface plots (:issue:`2235` :issue:`5084` :pull:`5101`).
45+
By `John Omotani <https://github.com/johnomotani>`_.
4546
- Allow passing multiple arrays to :py:meth:`Dataset.__setitem__` (:pull:`5216`).
4647
By `Giacomo Caria <https://github.com/gcaria>`_.
4748
- Add 'cumulative' option to :py:meth:`Dataset.integrate` and
4849
:py:meth:`DataArray.integrate` so that result is a cumulative integral, like
49-
:py:meth:`scipy.integrate.cumulative_trapezoidal` (:pull:`5153`).
50+
:py:func:`scipy.integrate.cumulative_trapezoidal` (:pull:`5153`).
5051
By `John Omotani <https://github.com/johnomotani>`_.
5152
- Add ``safe_chunks`` option to :py:meth:`Dataset.to_zarr` which allows overriding
5253
checks made to ensure Dask and Zarr chunk compatibility (:issue:`5056`).
5354
By `Ryan Abernathey <https://github.com/rabernat>`_
5455
- Add :py:meth:`Dataset.query` and :py:meth:`DataArray.query` which enable indexing
5556
of datasets and data arrays by evaluating query expressions against the values of the
56-
data variables (:pull:`4984`). By `Alistair Miles <https://github.com/alimanfoo>`_.
57+
data variables (:pull:`4984`).
58+
By `Alistair Miles <https://github.com/alimanfoo>`_.
5759
- Allow passing ``combine_attrs`` to :py:meth:`Dataset.merge` (:pull:`4895`).
5860
By `Justus Magin <https://github.com/keewis>`_.
5961
- Support for `dask.graph_manipulation
@@ -78,6 +80,7 @@ New Features
7880
:py:meth:`DataArray.str.rsplit`, and :py:meth:`DataArray.str.split`.
7981
A number of these methods allow for splitting or joining the strings in an
8082
array. (:issue:`4622`)
83+
By `Todd Jennings <https://github.com/toddrjen>`_
8184
- Thanks to the new pluggable backend infrastructure external packages may now
8285
use the ``xarray.backends`` entry point to register additional engines to be used in
8386
:py:func:`open_dataset`, see the documentation in :ref:`add_a_backend`
@@ -97,8 +100,8 @@ New Features
97100
way to open example rasterio files (:issue:`3986`, :pull:`4102`, :pull:`5074`).
98101
By `Justus Magin <https://github.com/keewis>`_.
99102
- Add typing information to unary and binary arithmetic operators operating on
100-
:py:class:`~core.dataset.Dataset`, :py:class:`~core.dataarray.DataArray`,
101-
:py:class:`~core.variable.Variable`, :py:class:`~core.groupby.DatasetGroupBy` or
103+
:py:class:`Dataset`, :py:class:`DataArray`, :py:class:`Variable`,
104+
:py:class:`~core.groupby.DatasetGroupBy` or
102105
:py:class:`~core.groupby.DataArrayGroupBy` (:pull:`4904`).
103106
By `Richard Kleijn <https://github.com/rhkleijn>`_.
104107
- Add a ``combine_attrs`` parameter to :py:func:`open_mfdataset` (:pull:`4971`).
@@ -107,7 +110,8 @@ New Features
107110
:py:meth:`DataArray.clip` & :py:meth:`Dataset.clip`; these methods now use
108111
:py:func:`xarray.apply_ufunc`; (:pull:`5184`).
109112
By `Maximilian Roos <https://github.com/max-sixty>`_.
110-
- Disable the `cfgrib` backend if the `eccodes` library is not installed (:pull:`5083`). By `Baudouin Raoult <https://github.com/b8raoult>`_.
113+
- Disable the `cfgrib` backend if the `eccodes` library is not installed (:pull:`5083`).
114+
By `Baudouin Raoult <https://github.com/b8raoult>`_.
111115
- Added :py:meth:`DataArray.curvefit` and :py:meth:`Dataset.curvefit` for general curve fitting applications. (:issue:`4300`, :pull:`4849`)
112116
By `Sam Levang <https://github.com/slevang>`_.
113117
- Add options to control expand/collapse of sections in display of Dataset and
@@ -118,15 +122,16 @@ New Features
118122
pre-defined limit (:pull:`5126`).
119123
By `Tom White <https://github.com/tomwhite>`_.
120124
- Significant speedups in :py:meth:`Dataset.interp` and :py:meth:`DataArray.interp`.
121-
(:issue:`4739`, :pull:`4740`). By `Deepak Cherian <https://github.com/dcherian>`_.
125+
(:issue:`4739`, :pull:`4740`).
126+
By `Deepak Cherian <https://github.com/dcherian>`_.
122127
- Prevent passing `concat_dim` to :py:func:`xarray.open_mfdataset` when
123128
`combine='by_coords'` is specified, which should never have been possible (as
124129
:py:func:`xarray.combine_by_coords` has no `concat_dim` argument to pass to).
125130
Also removes unneeded internal reordering of datasets in
126131
:py:func:`xarray.open_mfdataset` when `combine='by_coords'` is specified.
127132
Fixes (:issue:`5230`).
128133
By `Tom Nicholas <https://github.com/TomNicholas>`_.
129-
- Implement ``__setitem__`` for :py:class:`core.indexing.DaskIndexingAdapter` if
134+
- Implement ``__setitem__`` for ``xarray.core.indexing.DaskIndexingAdapter`` if
130135
dask version supports item assignment. (:issue:`5171`, :pull:`5174`)
131136
By `Tammas Loughran <https://github.com/tammasloughran>`_.
132137

@@ -152,8 +157,8 @@ Breaking changes
152157
- Functions that are identities for 0d data return the unchanged data
153158
if axis is empty. This ensures that Datasets where some variables do
154159
not have the averaged dimensions are not accidentially changed
155-
(:issue:`4885`, :pull:`5207`). By `David Schwörer
156-
<https://github.com/dschwoerer>`_
160+
(:issue:`4885`, :pull:`5207`).
161+
By `David Schwörer <https://github.com/dschwoerer>`_.
157162
- :py:attr:`DataArray.coarsen` and :py:attr:`Dataset.coarsen` no longer support passing ``keep_attrs``
158163
via its constructor. Pass ``keep_attrs`` via the applied function, i.e. use
159164
``ds.coarsen(...).mean(keep_attrs=False)`` instead of ``ds.coarsen(..., keep_attrs=False).mean()``.
@@ -184,10 +189,15 @@ Deprecations
184189
Bug fixes
185190
~~~~~~~~~
186191
- Properly support :py:meth:`DataArray.ffill`, :py:meth:`DataArray.bfill`, :py:meth:`Dataset.ffill`, :py:meth:`Dataset.bfill` along chunked dimensions.
187-
(:issue:`2699`).By `Deepak Cherian <https://github.com/dcherian>`_.
192+
(:issue:`2699`).
193+
By `Deepak Cherian <https://github.com/dcherian>`_.
188194
- Fix 2d plot failure for certain combinations of dimensions when `x` is 1d and `y` is
189-
2d (:issue:`5097`, :pull:`5099`). By `John Omotani <https://github.com/johnomotani>`_.
190-
- Ensure standard calendar times encoded with large values (i.e. greater than approximately 292 years), can be decoded correctly without silently overflowing (:pull:`5050`). This was a regression in xarray 0.17.0. By `Zeb Nicholls <https://github.com/znicholls>`_.
195+
2d (:issue:`5097`, :pull:`5099`).
196+
By `John Omotani <https://github.com/johnomotani>`_.
197+
- Ensure standard calendar times encoded with large values (i.e. greater than
198+
approximately 292 years), can be decoded correctly without silently overflowing
199+
(:pull:`5050`). This was a regression in xarray 0.17.0.
200+
By `Zeb Nicholls <https://github.com/znicholls>`_.
191201
- Added support for `numpy.bool_` attributes in roundtrips using `h5netcdf` engine with `invalid_netcdf=True` [which casts `bool`s to `numpy.bool_`] (:issue:`4981`, :pull:`4986`).
192202
By `Victor Negîrneac <https://github.com/caenrigen>`_.
193203
- Don't allow passing ``axis`` to :py:meth:`Dataset.reduce` methods (:issue:`3510`, :pull:`4940`).
@@ -204,11 +214,14 @@ Bug fixes
204214
- Warn on passing ``keep_attrs`` to ``resample`` and ``rolling_exp`` as they are ignored, pass ``keep_attrs``
205215
to the applied function instead (:pull:`5265`). By `Mathias Hauser <https://github.com/mathause>`_.
206216

217+
(:issue:`5093`, :pull:`5180`).
218+
By `Spencer Clark <https://github.com/spencerkclark>`_.
207219

208220
Documentation
209221
~~~~~~~~~~~~~
210222
- New section on :ref:`add_a_backend` in the "Internals" chapter aimed to backend developers
211-
(:issue:`4803`, :pull:`4810`). By `Aureliana Barghini <https://github.com/aurghs>`_.
223+
(:issue:`4803`, :pull:`4810`).
224+
By `Aureliana Barghini <https://github.com/aurghs>`_.
212225
- Add :py:meth:`Dataset.polyfit` and :py:meth:`DataArray.polyfit` under "See also" in
213226
the docstrings of :py:meth:`Dataset.polyfit` and :py:meth:`DataArray.polyfit`
214227
(:issue:`5016`, :pull:`5020`).
@@ -219,7 +232,8 @@ Documentation
219232
Internal Changes
220233
~~~~~~~~~~~~~~~~
221234
- Enable displaying mypy error codes and ignore only specific error codes using
222-
``# type: ignore[error-code]`` (:pull:`5096`). By `Mathias Hauser <https://github.com/mathause>`_.
235+
``# type: ignore[error-code]`` (:pull:`5096`).
236+
By `Mathias Hauser <https://github.com/mathause>`_.
223237
- Replace uses of ``raises_regex`` with the more standard
224238
``pytest.raises(Exception, match="foo")``;
225239
(:pull:`5188`), (:pull:`5191`).
@@ -380,7 +394,8 @@ Bug fixes
380394
- Resolve intervals before appending other metadata to labels when plotting (:issue:`4322`, :pull:`4794`).
381395
By `Justus Magin <https://github.com/keewis>`_.
382396
- Fix regression when decoding a variable with a ``scale_factor`` and ``add_offset`` given
383-
as a list of length one (:issue:`4631`) by `Mathias Hauser <https://github.com/mathause>`_.
397+
as a list of length one (:issue:`4631`).
398+
By `Mathias Hauser <https://github.com/mathause>`_.
384399
- Expand user directory paths (e.g. ``~/``) in :py:func:`open_mfdataset` and
385400
:py:meth:`Dataset.to_zarr` (:issue:`4783`, :pull:`4795`).
386401
By `Julien Seguinot <https://github.com/juseg>`_.
@@ -392,13 +407,15 @@ Bug fixes
392407
:pull:`4855`).
393408
By `Leif Denby <https://github.com/leifdenby>`_.
394409
- Fix time encoding bug associated with using cftime versions greater than
395-
1.4.0 with xarray (:issue:`4870`, :pull:`4871`). By `Spencer Clark <https://github.com/spencerkclark>`_.
410+
1.4.0 with xarray (:issue:`4870`, :pull:`4871`).
411+
By `Spencer Clark <https://github.com/spencerkclark>`_.
396412
- Stop :py:meth:`DataArray.sum` and :py:meth:`DataArray.prod` computing lazy
397413
arrays when called with a ``min_count`` parameter (:issue:`4898`, :pull:`4911`).
398414
By `Blair Bonnett <https://github.com/bcbnz>`_.
399415
- Fix bug preventing the ``min_count`` parameter to :py:meth:`DataArray.sum` and
400416
:py:meth:`DataArray.prod` working correctly when calculating over all axes of
401-
a float64 array (:issue:`4898`, :pull:`4911`). By `Blair Bonnett <https://github.com/bcbnz>`_.
417+
a float64 array (:issue:`4898`, :pull:`4911`).
418+
By `Blair Bonnett <https://github.com/bcbnz>`_.
402419
- Fix decoding of vlen strings using h5py versions greater than 3.0.0 with h5netcdf backend (:issue:`4570`, :pull:`4893`).
403420
By `Kai Mühlbauer <https://github.com/kmuehlbauer>`_.
404421
- Allow converting :py:class:`Dataset` or :py:class:`DataArray` objects with a ``MultiIndex``

0 commit comments

Comments
 (0)