Skip to content

Commit

Permalink
improved docstring of to_netcdf (issue #7127) (#7947)
Browse files Browse the repository at this point in the history
* improved docstring of to_netcdf (issue #7127)

* Spelling

* Update xarray/core/dataset.py

---------

Co-authored-by: Tom Nicholas <thomas.nicholas@columbia.edu>
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
  • Loading branch information
3 people authored Jul 21, 2023
1 parent 4441f99 commit 971be10
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion xarray/core/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -2042,7 +2042,9 @@ def to_netcdf(
Nested dictionary with variable names as keys and dictionaries of
variable specific encodings as values, e.g.,
``{"my_variable": {"dtype": "int16", "scale_factor": 0.1,
"zlib": True}, ...}``
"zlib": True}, ...}``.
If ``encoding`` is specified the original encoding of the variables of
the dataset is ignored.
The `h5netcdf` engine supports both the NetCDF4-style compression
encoding parameters ``{"zlib": True, "complevel": 9}`` and the h5py
Expand Down

0 comments on commit 971be10

Please sign in to comment.