Repository navigation
fix(tests): repair docstring-consistency test and align create_array docs - #4417
Merged
d-v-b merged 3 commits intoSep 30, 2026
Merged
Conversation
Contributor
|
🤖 AI text below 🤖 The changelog fragment git mv changes/4225.bugfix.md changes/4417.misc.mdThis PR is planned for the 3.4.1 patch release. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4417 +/- ##
=======================================
Coverage 94.44% 94.44%
=======================================
Files 93 93
Lines 13221 13221
=======================================
Hits 12487 12487
Misses 734 734
🚀 New features to boost your workflow:
|
The rebuilt test now parametrizes one case per documented parameter over the create_array variants (module-level, AsyncGroup, Group, Group.create), deriving the parameter list from the docstrings so new parameters are checked automatically; `name` is the only deliberate exemption. Docstring fixes surfaced by the widened check: - `data` was malformed on Group.create/Group.create_array and missing on AsyncGroup.create_array - `chunk_key_encoding` and `config` documented types that differ from the signatures (ChunkKeyEncodingLike, ArrayConfigLike) - `overwrite` now says what happens (keys under the path are deleted) in all variants instead of "all existing paths in the store" - stray `}}` in the chunk key encoding examples - `VariableLengthUTF8` listed twice where `VariableLengthBytes` was meant - dangling "in zarr.config." fragment after the v2 default-compressor line - Group.create used unresolved `[zarr.config][]` cross-refs Rename the changelog fragment to the pull request number. Assisted-by: ClaudeCode:claude-fable-5-1
Contributor
|
thanks for this @guhou-hvi, I pushed a few additional changes on top of yours:
|
d-v-b
approved these changes
Sep 30, 2026
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.
Problem
test_docstring_consistent_parametersintests/test_api/test_synchronous.pysilently passed regardless of docstring mismatches:shards, fill_valueinto a single stringshardsfill_value, so neither parameter was checked.parameter_nameis a tuple, but the body didif parameter_name in param_dict:— looking up the tuple as a key, which is alwaysFalse.Fixes #4225.
Changes
filters,compressors,chunks,shape,dtype(description and type) acrosscore.array.create_array,api.synchronous.create_array,AsyncGroup.create_arrayandGroup.create_array.) to markdown single-backticks in the threecreate_array` docstring blocks.filtersparagraph.Verification