Repository navigation
Conversation
Add a new user-guide page that describes exactly what zarr-python reads and writes for consolidated metadata in Zarr formats 2 and 3, so that other implementations can interoperate. Quotes and attributes the schema text from zarr-specs#309 (Tom Augspurger, CC-BY-4.0), documents the key ordering, the empty child-group marker, the v2 `.zmetadata` layout and its deviation from zarr-python 2.x, and the reader/writer procedures. Also correct the 3.1.1 sort-order note on the existing page, which said "lexicographic" while the implementation uses NFKC-casefolded ordering. Assisted-by: ClaudeCode:claude-fable-5
Co-authored-by: Tom Augspurger <tom.augspurger88@gmail.com>
Co-authored-by: Tom Augspurger <tom.augspurger88@gmail.com>
Assisted-by: Codex:GPT-6
Assisted-by: Codex:GPT-6
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 AI text below 🤖
Adds a specification-style description of Zarr-Python's consolidated metadata encoding and reader behavior, linked from the usage guide and navigation. It covers V2
.zmetadata, V3 inline metadata, path and child-marker conventions, ordering, anduse_consolidatedbehavior.This documents implementation behavior and interoperability guidance; it is not an adopted Zarr specification. At the factual review, zarr-specs#309 remains open and unmerged. Excerpts are attributed to Tom Augspurger and the repository's CC-BY-4.0 license.
The sort-order correction is depth first, then Unicode NFKC normalization and case folding. For equal-depth keys,
aprecedesB, unlike raw Unicode code-point ordering. The previous exampleBbeforexdemonstrated no difference. Equal normalized keys retain input order, so this does not establish universally byte-identical output.The page distinguishes current reader acceptance from writer recommendations, including mixed-format entries, ignored
must_understand, and V2 child-group markers. It also documents that deletion can resave consolidated metadata while other mutations need not keep snapshots synchronized. No runtime behavior changes are included.The factual follow-up clarifies the document's status; applicable commit hooks pass. The earlier strict documentation build is historical validation.