Skip to content

Commit df94a0a

Browse files
authored
docs(zarr-metadata): condense the pending release notes and renumber the #4598 fragment (#4617)
Replace the ten bugfix fragments of #4574 with three, two of them marked breaking, and shorten the #4592 fragment to the rename and the names a user is most likely to have imported. The removed detail stays in the pull requests. Rename 427.removal.md to 4598.removal.md: the fragment came in with #4598 but carried the fork PR's number, so the changelog would have linked to an unrelated upstream PR. Assisted-by: ClaudeCode:claude-opus-5-5
1 parent f3d406f commit df94a0a

12 files changed

Lines changed: 4 additions & 85 deletions
Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1 @@
1-
**Breaking:** A problem in a v2 struct dtype is located where the document
2-
writes it. A record's problem was located under a `fields` key the
3-
document does not have, at `("dtype", "fields", 0, 1)`; it is now at
4-
`("dtype", 0, 1)`, and carries the value found there as its `input`.
5-
`declarations()` places each record's type there too. A definition's
6-
functions still find the record types in `nested` at
7-
`("fields", 0, 1)`, their place in the configuration.
1+
**Breaking:** Every problem is now located where the document writes the value. The v2 readers and the v2 models' `from_key_value` locate a problem in the file that holds it, such as `(".zarray", "order")` or `(".zattrs", "x")`, instead of in the merged document, and a v2 array node reading's `at` is now `(".zarray",)`. A problem in a v2 struct record is at `("dtype", 0, 1)` instead of under a `fields` key the document does not have, a codec's missing configuration member, such as the `endian` of a `bytes` codec, is reported inside the configuration it writes, or at `codecs.N.configuration` when it writes none, and a codec handed values it cannot encode is reported at `codecs.N` however it is spelled.

‎packages/zarr-metadata/changes/4574.bugfix.10.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
A v2 dtype written as the string `"struct"` is refused as a string that is
2-
not a NumPy typestr, like any other, instead of being read as a struct
3-
with no records. `struct` is the name the definition of a records array
4-
is filed under, not part of the v2 dtype grammar.
1+
**Breaking:** The v2 readers now agree with the v3 readers. A `.zarray` member the spec does not define may hold `NaN` and the infinities, a `.zmetadata` key that does not name its node's path, such as `/a/.zarray`, is refused instead of being read as the node at `a`, and a `.zgroup` that holds `attributes` is an `invalid_value` rather than an `unknown_key`, so a caller who tolerates unknown keys no longer drops those attributes.
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
A group listed in v3 consolidated metadata whose own document has a problem,
2-
such as attributes that are not an object, is reported for that problem
3-
alone. It was also reported for disagreeing with the outer listing's copy
4-
of the same node, a difference that came only from the problem. A copy
5-
whose only problem is an unknown key is still compared.
1+
Various mistakes in v2 and consolidated metadata are now reported once, at their own location, with the right kind and message. A float where an integer from a fixed set is required, such as `"zarr_format": 2.0`, is an `invalid_type`, and a v2 typestr with a part its family does not take, such as `<f4[ns]`, or a time typestr without a unit, is a single `invalid_value` that names the part. A struct record of the wrong length or with a non-string name, the string `"struct"` given as a v2 dtype, a node that v3 consolidated metadata lists and whose own document has a problem, and a malformed inline `consolidated_metadata` member are each reported for their own problem alone, with the value found there as the problem's `input`.

‎packages/zarr-metadata/changes/4574.bugfix.4.md‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎packages/zarr-metadata/changes/4574.bugfix.5.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎packages/zarr-metadata/changes/4574.bugfix.6.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎packages/zarr-metadata/changes/4574.bugfix.7.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎packages/zarr-metadata/changes/4574.bugfix.8.md‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎packages/zarr-metadata/changes/4574.bugfix.9.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)