Repository navigation
docs: clarify Zarr v3 codec pipeline roles - #4166
Merged
d-v-b merged 10 commits intoOct 26, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4166 +/- ##
=======================================
Coverage 94.73% 94.73%
=======================================
Files 94 94
Lines 13692 13692
=======================================
Hits 12971 12971
Misses 721 721
🚀 New features to boost your workflow:
|
mgalore
force-pushed
the
docs/issue-4159-array-bytes-codec
branch
from
September 4, 2026 17:07
91778d4 to
a5f91c4
Compare
Revert RST-style double backticks to single backticks in the edited docstrings, replace references to the removed array.v3_default_compressors / array.v3_default_serializer config keys with the actual Zarr format 3 defaults, and rename the changelog fragment after the PR number. Assisted-by: ClaudeCode:claude-opus-5-5
Documentation build overview
12 files changed ·
|
Documentation build overview
27 files changed ·
|
State that these names are not defined in the Zarr format 3 specification, and map each one to the spec's codec kind (array -> array, array -> bytes, bytes -> bytes) with links to the spec's chunk encoding section and `codecs` metadata field. Assisted-by: ClaudeCode:claude-opus-5-5
Contributor
|
I pushed some clarification (e.g., that "filters", "serializer", "compressor" are zarr-pythonisms that the spec does not define). thanks @mgalore |
d-v-b
approved these changes
Oct 9, 2026
d-v-b
enabled auto-merge (squash)
October 9, 2026 16:35
Copy the `compressors` and `serializer` descriptions from `zarr.create_array` into `AsyncGroup.create_array`, `Group.create`, and `Group.create_array`, so `test_docstring_consistent_parameters` passes. Assisted-by: ClaudeCode:claude-opus-5-5
Contributor
|
I pushed changes necessary to get our docstring tests passing. I'm merging when this is green |
d-v-b
added a commit
that referenced
this pull request
Oct 26, 2026
#4569) The example added in #4166 creates `data/example-explicit-serializer.zarr` without `overwrite=True`, so running the docs build or the docs example tests a second time in the same directory raises `ContainsArrayError`. Every other example on the page overwrites. Assisted-by: ClaudeCode:claude-opus-5-5 Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Summary
Clarifies how the Zarr v3 codec pipeline maps to
filters,serializer, andcompressors, resolving the ambiguity that led ArrayBytes codecs such as imagecodecs JPEG-XL to be supplied as compressors. Adds an executableBytesCodecserializer example, updates the relevant API references, and includes a documentation news fragment.Closes #4159
For reviewers
The change is documentation and docstring-only. The main point to check is that the descriptions accurately distinguish ArrayArray, ArrayBytes, and BytesBytes codec roles and that the explicit serializer example reflects the API.
Author attestation
TODO
docs/user-guide/*.mdchanges/Validation
pytest -q tests/test_docs.py::test_no_unvalidated_blocks tests/test_docs.py::test_test_only_blocks_come_last tests/test_docs.py::test_documentation_examples[user-guide/arrays.md:arrays](3 passed)mkdocs build --strictstarted successfully but was terminated by the local runner (exit 137) during the complete site build; the targeted executable documentation test above passed.markdownlint-cli2 --files docs/user-guide/arrays.mdtowncrier check --compare-with HEADgit diff --check