Skip to content

Commit 0df70ec

Browse files
committed
More minor doc fixes
1 parent 97af4b8 commit 0df70ec

File tree

3 files changed

+16
-5
lines changed

3 files changed

+16
-5
lines changed

doc/whats-new.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,11 @@ Enhancements
3333

3434
- New documentation on :ref:`panel transition`. By
3535
`Maximilian Roos <https://github.com/MaximilianR>`_.
36-
- New ``Dataset`` and ``DataArray`` methods :py:meth:`to_dict` and
37-
:py:meth:`from_dict` to allow easy conversion between dictionaries and
38-
xarray objects (:issue:`432`). See :ref:`dictionary IO <dictionary io>`
39-
for more details. By `Julia Signell <https://github.com/jsignell>`_.
36+
- New ``Dataset`` and ``DataArray`` methods :py:meth:`~xarray.Dataset.to_dict`
37+
and :py:meth:`~xarray.Dataset.from_dict` to allow easy conversion between
38+
dictionaries and xarray objects (:issue:`432`). See
39+
:ref:`dictionary IO<dictionary io>` for more details.
40+
By `Julia Signell <https://github.com/jsignell>`_.
4041
- Added ``exclude`` and ``indexes`` optional parameters to :py:func:`~xarray.align`,
4142
and ``exclude`` optional parameter to :py:func:`~xarray.broadcast`.
4243
By `Guido Imperiale <https://github.com/crusaderky>`_.
@@ -55,7 +56,7 @@ Bug fixes
5556
By `Maximilian Roos <https://github.com/maximilianr>`_.
5657
- ``Dataset`` constructor can now take arbitrary objects as values
5758
(:issue:`647`). By `Maximilian Roos <https://github.com/maximilianr>`_.
58-
- Clarified ``copy`` argument for :py:meth`~xarray.DataArray.reindex` and
59+
- Clarified ``copy`` argument for :py:meth:`~xarray.DataArray.reindex` and
5960
:py:func:`~xarray.align`, which now consistently always return new xarray
6061
objects (:issue:`927`).
6162
- Fix ``open_mfdataset`` with ``engine='pynio'`` (:issue:`936`).

xarray/core/dataarray.py

+5
Original file line numberDiff line numberDiff line change
@@ -1101,6 +1101,10 @@ def to_dict(self):
11011101
naming conventions.
11021102
11031103
Useful for coverting to json.
1104+
1105+
See also
1106+
--------
1107+
xarray.DataArray.from_dict
11041108
"""
11051109
d = {'coords': {}, 'attrs': dict(self.attrs), 'dims': self.dims}
11061110

@@ -1151,6 +1155,7 @@ def from_dict(cls, d):
11511155
11521156
See also
11531157
--------
1158+
xarray.DataArray.to_dict
11541159
xarray.Dataset.from_dict
11551160
"""
11561161
coords = None

xarray/core/dataset.py

+5
Original file line numberDiff line numberDiff line change
@@ -1915,6 +1915,10 @@ def to_dict(self):
19151915
conventions.
19161916
19171917
Useful for coverting to json.
1918+
1919+
See also
1920+
--------
1921+
xarray.Dataset.from_dict
19181922
"""
19191923
d = {'coords': {}, 'attrs': dict(self.attrs), 'dims': dict(self.dims),
19201924
'data_vars': {}}
@@ -1972,6 +1976,7 @@ def from_dict(cls, d):
19721976
19731977
See also
19741978
--------
1979+
xarray.Dataset.to_dict
19751980
xarray.DataArray.from_dict
19761981
"""
19771982

0 commit comments

Comments
 (0)