Skip to content

Commit fe6d719

Browse files
authored
[spec] Clarify that arbitrary key/value pairs are OK for attributes (#751)
This came up in: zarr-developers/zarr-specs#41 (comment)
1 parent 727f0d8 commit fe6d719

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/spec/v2.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -326,11 +326,11 @@ under the logical paths "foo" and "foo/bar" and an array exists at logical path
326326
Attributes
327327
----------
328328

329-
An array or group can be associated with custom attributes, which are simple
330-
key/value items with application-specific meaning. Custom attributes are
331-
encoded as a JSON object and stored under the ".zattrs" key within an array
332-
store. The ".zattrs" key does not have to be present, and if it is absent the
333-
attributes should be treated as empty.
329+
An array or group can be associated with custom attributes, which are arbitrary
330+
key/value pairs with application-specific meaning. Custom attributes are encoded
331+
as a JSON object and stored under the ".zattrs" key within an array store. The
332+
".zattrs" key does not have to be present, and if it is absent the attributes
333+
should be treated as empty.
334334

335335
For example, the JSON object below encodes three attributes named
336336
"foo", "bar" and "baz"::
@@ -545,6 +545,8 @@ initially published to clarify ambiguities and add some missing information.
545545
subarray shapes and/or with nested structured data types are encoded
546546
in array metadata (:issue:`111`, :issue:`296`).
547547

548+
* Clarified the key/value pairs of custom attributes as "arbitrary" rather than
549+
"simple".
548550

549551
Changes from version 1 to version 2
550552
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)