Skip to content

Commit a0faed8

Browse files
committed
Update design doc
1 parent ce8caca commit a0faed8

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

design/chunk-grid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Prior iterations on the chunk grid design were based on the Zarr V3 spec's defin
2929

3030
## Goals
3131

32-
1. **Follow the zarr extension proposal.** The implementation should conform to the [rectilinear chunk grid spec](https://github.com/zarr-developers/zarr-extensions/pull/25), not innovate on the metadata format.
32+
1. **Follow the zarr extension proposal.** The implementation should conform to the [rectilinear chunk grid spec](https://github.com/zarr-developers/zarr-extensions/tree/main/chunk-grids/rectilinear), not innovate on the metadata format.
3333
2. **Minimize changes to the public API.** Users creating regular arrays should see no difference. Rectilinear is additive.
34-
3. **Maintain backwards compatibility.** Existing code using `.chunks`, `isinstance` checks, or importing `RegularChunkGrid`/`RectilinearChunkGrid` from `zarr.core.chunk_grids` should continue to work (with deprecation warnings where appropriate).
34+
3. **Maintain backwards compatibility.** Existing code using `.chunks`, `isinstance` checks, or importing `RegularChunkGrid`/`RectilinearChunkGrid` from `zarr.core.chunk_grids` should continue to work where practical (with deprecation warnings where appropriate). Internal code paths/imports may be broken with justification.
3535
4. **Design for future iteration.** The internal architecture should allow refactoring (e.g., metadata/array separation, new dimension types) without breaking the public API.
3636
5. **Minimize downstream changes.** xarray, VirtualiZarr, Icechunk, Cubed, etc. should need minimal updates.
3737
6. **Minimize time to stable release.** Ship behind a feature flag, stabilize through real-world usage, promote to stable API.

0 commit comments

Comments
 (0)