@@ -2458,24 +2458,26 @@ def to_zarr(
2458
2458
If set, the dimension along which the data will be appended. All
2459
2459
other dimensions on overridden variables must remain the same size.
2460
2460
region : dict or "auto", optional
2461
- Optional mapping from dimension names to integer slices along
2462
- dataset dimensions to indicate the region of existing zarr array(s)
2463
- in which to write this dataset's data. For example,
2464
- ``{'x': slice(0, 1000), 'y': slice(10000, 11000)}`` would indicate
2465
- that values should be written to the region ``0:1000`` along ``x``
2466
- and ``10000:11000`` along ``y``.
2467
-
2468
- Can also specify ``"auto"``, in which case the existing store will be
2469
- opened and the region inferred by matching the new data's coordinates.
2470
- ``"auto"`` can be used as a single string, which will automatically infer
2471
- the region for all dimensions, or as dictionary values for specific
2472
- dimensions mixed together with explicit slices for other dimensions.
2461
+ Optional mapping from dimension names to either a) ``"auto"``, or b) integer
2462
+ slices, indicating the region of existing zarr array(s) in which to write
2463
+ this dataset's data.
2464
+
2465
+ If ``"auto"`` is provided the existing store will be opened and the region
2466
+ inferred by matching indexes. ``"auto"`` can be used as a single string,
2467
+ which will automatically infer the region for all dimensions, or as
2468
+ dictionary values for specific dimensions mixed together with explicit
2469
+ slices for other dimensions.
2470
+
2471
+ Alternatively integer slices can be provided; for example, ``{'x': slice(0,
2472
+ 1000), 'y': slice(10000, 11000)}`` would indicate that values should be
2473
+ written to the region ``0:1000`` along ``x`` and ``10000:11000`` along
2474
+ ``y``.
2473
2475
2474
2476
Two restrictions apply to the use of ``region``:
2475
2477
2476
2478
- If ``region`` is set, _all_ variables in a dataset must have at
2477
2479
least one dimension in common with the region. Other variables
2478
- should be written in a separate call to ``to_zarr()``.
2480
+ should be written in a separate single call to ``to_zarr()``.
2479
2481
- Dimensions cannot be included in both ``region`` and
2480
2482
``append_dim`` at the same time. To create empty arrays to fill
2481
2483
in with ``region``, use a separate call to ``to_zarr()`` with
0 commit comments