Repository navigation
docs(zarr-metadata): document every public object - #4590
Merged
d-v-b merged 3 commits intoNov 2, 2026
Merged
Conversation
github-actions
Bot
added
needs release notes
Documentation build overview
13 files changed ·
|
Add a docstring to every public object, and a test that fails on an undocumented public object, a public module with no reference page, or a v2 on-disk field docstring that drifts from its in-memory counterpart. Assisted-by: ClaudeCode:claude-opus-5-5
…t pass Cover the vlen codecs, the fixed-width string data types and the strategy records, and render zarr_metadata.testing, which has no __all__. Assisted-by: ClaudeCode:claude-opus-5-5
d-v-b
force-pushed
the
claude/zarr-metadata-api-docs-13ef0c
branch
from
November 2, 2026 08:00
c30fcee to
1d602b2
Compare
Drop the struct sentence, since main already renders that page. Assisted-by: ClaudeCode:claude-opus-5-5
d-v-b
changed the title
d-v-b
marked this pull request as ready for review
November 2, 2026 08:09
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4590 +/- ##
=======================================
Coverage 94.84% 94.84%
=======================================
Files 96 96
Lines 13998 13998
=======================================
Hits 13276 13276
Misses 722 722 🚀 New features to boost your workflow:
|
Contributor
Author
|
this is internal to zarr-metadata so i am self-merging |
d-v-b
added a commit
to d-v-b/zarr-python
that referenced
this pull request
Nov 2, 2026
Resolve the rename against the four zarr-metadata changes main gained: the ZARR_PYTHON_CONTEXT scope and the *_CONTEXT constant names (zarr-developers#4583), the v3 submodule re-exports (zarr-developers#4588), the Hypothesis strategies (zarr-developers#4575) and the docstrings for every public object (zarr-developers#4590). Every conflict was the rename on one side and new upstream text on the other, so each is resolved as the upstream text with the rename applied. The rename is carried into upstream's additions: the new docstrings say "field" for a JSON key and "declaration" for an extension-point value, and the strategies module's `fields` strategy is `declarations`, with `FieldForm` now `DeclarationForm` in its tests. The zarr-developers#4575 changelog fragment uses the new name, since neither name has been released. Assisted-by: ClaudeCode:claude-fable-5-1 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
d-v-b
added a commit
to d-v-b/zarr-python
that referenced
this pull request
Nov 2, 2026
This branch was squash-merged upstream as zarr-developers#4575 (4a72dd4), whose tree matches this branch's head. Each conflict is main's later change to the same files (zarr-developers#4583, zarr-developers#4588, zarr-developers#4590, zarr-developers#4592), so every file takes main's side, and the branch now matches main. 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
Adds docstrings for all public objects and gets them wired up to the API docs.
Author attestation
TODO
docs/user-guide/*.mdchanges/