Skip to content

Commit 0cef5e6

Browse files
committed
document changes
1 parent 08fa7f5 commit 0cef5e6

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

changes/2866.feature.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
If metadata JSON contains invalid keys, or if a value object contains invalid keys, the zarr array will be rejected unless it contains the key-value-pair ``"must_understand": false``.
2+
New codecs are required to validate their metadata and raise an error if it is invalid.

docs/user-guide/extending.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ Custom codecs should also implement the following methods:
5050
- ``evolve_from_array_spec`` (optional), which can be useful for automatically filling in
5151
codec configuration metadata from the array metadata.
5252

53+
On initialization, custom codecs should reject unexpected metadata keys except for objects
54+
marked with ``"must_understand": false``.
55+
5356
To use custom codecs in Zarr, they need to be registered using the
5457
`entrypoint mechanism <https://packaging.python.org/en/latest/specifications/entry-points/>`_.
5558
Commonly, entrypoints are declared in the ``pyproject.toml`` of your package under the

0 commit comments

Comments
 (0)