improved docstring of to_netcdf (issue pydata#7127)

vallirep · Jun 27, 2023 · 556326e · 556326e
1 parent 1146c5a
commit 556326e
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -1919,7 +1919,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 ingnored
 
             The `h5netcdf` engine supports both the NetCDF4-style compression
             encoding parameters ``{"zlib": True, "complevel": 9}`` and the h5py