Skip to content

Commit 484d1ce

Browse files
apatlpoAurélien Ponte
andauthored
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]>
1 parent 5c04ebf commit 484d1ce

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

xarray/core/dataset.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1604,6 +1604,15 @@ def to_zarr(
16041604
References
16051605
----------
16061606
https://zarr.readthedocs.io/
1607+
1608+
Notes
1609+
-----
1610+
Zarr chunking behavior:
1611+
If chunks are found in the encoding argument or attribute
1612+
corresponding to any DataArray, those chunks are used.
1613+
If a DataArray is a dask array, it is written with those chunks.
1614+
If not other chunks are found, Zarr uses its own heuristics to
1615+
choose automatic chunk sizes.
16071616
"""
16081617
if encoding is None:
16091618
encoding = {}

0 commit comments

Comments
 (0)