Skip to content

Improve the documentation of swap_dims #3331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 22, 2019
Merged

Improve the documentation of swap_dims #3331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
50221ab
add an example to DataArray.swap_dims (and fix the documented return …
keewis Sep 21, 2019
455968b
add an example to Dataset.swap_dims
keewis Sep 21, 2019
9029e5f
fix some errors in the swapped array's repr
keewis Sep 21, 2019
efb03f4
remove a newline
keewis Sep 22, 2019
0313df9
mention changes in whatsnew
keewis Sep 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Bug fixes
objects remain unaddressable by weakref in order to save memory.
(:issue:`3317`) by `Guido Imperiale <https://github.com/crusaderky>`_.

Documentation
~~~~~~~~~~~~~
- Add examples for :py:meth:`Dataset.swap_dims` and :py:meth:`DataArray.swap_dims`.
By `Justus Magin <https://github.com/keewis>`_.

.. _whats-new.0.13.0:

Expand Down
19 changes: 18 additions & 1 deletion xarray/core/dataarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1453,9 +1453,26 @@ def swap_dims(self, dims_dict: Mapping[Hashable, Hashable]) -> "DataArray":

Returns
-------
swapped : Dataset
swapped : DataArray
DataArray with swapped dimensions.

Examples
--------
>>> arr = xr.DataArray(data=[0, 1], dims="x",
coords={"x": ["a", "b"], "y": ("x", [0, 1])})
>>> arr
<xarray.DataArray (x: 2)>
array([0, 1])
Coordinates:
* x (x) <U1 'a' 'b'
y (x) int64 0 1
>>> arr.swap_dims({"x": "y"})
<xarray.DataArray (y: 2)>
array([0, 1])
Coordinates:
x (y) <U1 'a' 'b'
* y (y) int64 0 1

See Also
--------

Expand Down
23 changes: 23 additions & 0 deletions xarray/core/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2679,6 +2679,29 @@ def swap_dims(
swapped : Dataset
Dataset with swapped dimensions.

Examples
--------
>>> ds = xr.Dataset(data_vars={"a": ("x", [5, 7]), "b": ("x", [0.1, 2.4])},
coords={"x": ["a", "b"], "y": ("x", [0, 1])})
>>> ds
<xarray.Dataset>
Dimensions: (x: 2)
Coordinates:
* x (x) <U1 'a' 'b'
y (x) int64 0 1
Data variables:
a (x) int64 5 7
b (x) float64 0.1 2.4
>>> ds.swap_dims({"x": "y"})
<xarray.Dataset>
Dimensions: (y: 2)
Coordinates:
x (y) <U1 'a' 'b'
* y (y) int64 0 1
Data variables:
a (y) int64 5 7
b (y) float64 0.1 2.4

See Also
--------

Expand Down