improve to_zarr doc about chunking (#4048)

* Update dataset.py * attempt at improving the doc formulation * update to_zarr docstring * minor style update * seems to fix doc compilation locally * delete saved_on_disk.nc Co-authored-by: Aurélien Ponte <[email protected]>
pydata · May 20, 2020 · 484d1ce · 484d1ce
1 parent 5c04ebf
commit 484d1ce
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -1604,6 +1604,15 @@ def to_zarr(
         References
         ----------
         https://zarr.readthedocs.io/
+
+        Notes
+        -----
+        Zarr chunking behavior:
+            If chunks are found in the encoding argument or attribute
+            corresponding to any DataArray, those chunks are used.
+            If a DataArray is a dask array, it is written with those chunks.
+            If not other chunks are found, Zarr uses its own heuristics to
+            choose automatic chunk sizes.
         """
         if encoding is None:
             encoding = {}