Unable to run example for xarray.DataArray.to_unstacked_dataset

[TalfanBarnie]

Hello,

When I try to run the example for
xarray.DataArray.to_unstacked_dataset

I get the error:

Traceback (most recent call last):
File "", line 1, in
File "/home/talfan/anaconda3/envs/to_unstacked/lib/python3.7/site-packages/xarray/core/dataset.py", line 2915, in to_stacked_array
"dimensions {}.".format(dims)
ValueError: All variables in the dataset must contain the dimensions ('x',).

when running the line
stacked = data.to_stacked_array("z", ['y'])

This is my setup:

pip freeze
certifi==2019.6.16
numpy==1.16.4
pandas==0.25.0
python-dateutil==2.8.0
pytz==2019.1
six==1.12.0
xarray==0.12.3+20.g9afe4d0c

Any idea what might be going wrong?

Many thanks for your help!

[shoyer]

There's a typo in the docstring example. It should be data.to_stacked_array("z", ['x']).

[shoyer]

cc @nbren12

[nbren12]

Huh, it looks like that change in the API that happened in the last stages of the PR didn't make it into the example docs. I will try to submit a PR fixing that sometime soon.

[nbren12]

Actually, the docs seem correct:

xarray/xarray/core/dataset.py

Line 2895 in 8da3f67

>>> data.to_stacked_array("z", sample_dims=['x'])

Am I missing something here?

[TalfanBarnie]

The correction works, many thanks. The incorrect version is still on http://xarray.pydata.org/en/stable/, maybe that needs to be updated somehow?

[nbren12]

Could you link the specific page that is wrong?

[TalfanBarnie]

It's here:

http://xarray.pydata.org/en/stable/generated/xarray.DataArray.to_unstacked_dataset.html#xarray.DataArray.to_unstacked_dataset

Under examples the line that reads:

stacked = data.to_stacked_array("z", ['y'])

should read

data.to_stacked_array("z", ['x'])

Thanks for looking into it!

[nbren12]

Okay. it looks like the docstring for to_unstacked_dataset is in fact incorrect:

xarray/xarray/core/dataarray.py

Line 1654 in 77a31e5

>>> stacked = data.to_stacked_array("z", ['y'])

I will can submit a PR fixing that soon.

[keewis]

it looks like this should have been closed by #4408