Skip to content

fix doc dataarray to netcdf #4424

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 2 commits into from
Sep 17, 2020
Merged

fix doc dataarray to netcdf #4424

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20fc4fd
fix doc dataarray to netcdf
mathause Sep 14, 2020
c84b78d
codeblock
mathause Sep 16, 2020
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
10 changes: 7 additions & 3 deletions xarray/core/dataarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2490,15 +2490,19 @@ def to_masked_array(self, copy: bool = True) -> np.ma.MaskedArray:
def to_netcdf(self, *args, **kwargs) -> Union[bytes, "Delayed", None]:
"""Write DataArray contents to a netCDF file.

All parameters are passed directly to `xarray.Dataset.to_netcdf`.
All parameters are passed directly to :py:meth:`xarray.Dataset.to_netcdf`.

Notes
-----
Only xarray.Dataset objects can be written to netCDF files, so
the xarray.DataArray is converted to a xarray.Dataset object
containing a single variable. If the DataArray has no name, or if the
name is the same as a co-ordinate name, then it is given the name
'__xarray_dataarray_variable__'.
name is the same as a coordinate name, then it is given the name
``"__xarray_dataarray_variable__"``.

See Also
--------
Dataset.to_netcdf
"""
from ..backends.api import DATAARRAY_NAME, DATAARRAY_VARIABLE

Expand Down