Skip to content

Commit 811875b

Browse files
committed
more edits
1 parent ca28ac5 commit 811875b

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

docs/protocol/core/v3.0.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,8 @@ Questions that still need to be resolved
144144
We solicit feedback on the following area during the RFC period of this first
145145
draft.
146146

147-
- Should core metadata and user attributes be stored together or separate documents? (See https://github.com/zarr-developers/zarr-specs/issues/72)
147+
- Should core metadata and user attributes be stored together or separate documents?
148+
(See https://github.com/zarr-developers/zarr-specs/issues/72)
148149
- extensions and ``must_understand = True`` might be too restrictive.
149150
We propose to develop a draft implementation with extensions and
150151
see how far we can go. A possible list of extensions to implement includes:
@@ -987,7 +988,7 @@ following mandatory names:
987988
then said extension is responsible for interpreting the value of
988989
``fill_value`` and return a suitable type that can be used.
989990

990-
For core ``data_type`` which ``fill_value`` are not permitted in JSON or
991+
For core data types for which fill values are not permitted in JSON or
991992
for which decimal representation could be lossy, a string representing of
992993
the binary (starting with ``0b``) or hexadecimal value (starting with
993994
``0x``) is accepted. This string must include all leading or trailing
@@ -1003,7 +1004,13 @@ following mandatory names:
10031004
``attributes``
10041005

10051006
The value must be an object. The object may contain any name/value
1006-
pairs.
1007+
pairs. Intended to allow storage of arbitrary user metadata
1008+
1009+
1010+
.. note:: The question of whether core metadata and user attributes should be
1011+
stored together or in separate documents is a topic of ongoing discussion.
1012+
(See https://github.com/zarr-developers/zarr-specs/issues/72.)
1013+
10071014

10081015
The following names are optional:
10091016

@@ -1083,11 +1090,11 @@ chunking as above, but using an extension data type::
10831090

10841091
.. note::
10851092
comparison with spec v2,
1086-
``dtype`` have been renamed to ``data_type``,
1087-
``chunks`` have been renamed to ``chunk_grid``,
1088-
``order`` have been renamed to ``chunk_memory_layout``,
1089-
``filters`` have been removed,
1090-
``zarr_format`` have been removed,
1093+
``dtype`` has been renamed to ``data_type``,
1094+
``chunks`` has been renamed to ``chunk_grid``,
1095+
``order`` has been renamed to ``chunk_memory_layout``,
1096+
``filters`` has been removed,
1097+
``zarr_format`` has been removed,
10911098

10921099

10931100
Group metadata
@@ -1109,7 +1116,7 @@ For example, the JSON document below defines an explicit group::
11091116

11101117
.. note::
11111118

1112-
Groups cannot have extensions attached to them as of spec v3.0 Allowing
1119+
Groups cannot have extensions attached to them as of spec v3.0. Allowing
11131120
groups to have extensions would force any implementation to sequentially
11141121
traverse the store hierarchy in order to check for extensions, which would
11151122
defeat the purpose of a flat namespace and concurrent access.
@@ -1118,7 +1125,7 @@ For example, the JSON document below defines an explicit group::
11181125

11191126
.. note::
11201127

1121-
A group does not need a metadata document to exists, see implicit groups.
1128+
A group does not need a metadata document to exist. (See implicit groups.)
11221129

11231130

11241131

@@ -1366,8 +1373,8 @@ concatenating "data/root/" and the chunk identifier.
13661373
- Chunk grid indices
13671374
- Data key
13681375
* - `/foo/baz`
1369-
- `(0, 0)`
1370-
- `data/root/foo/baz/c0/0`
1376+
- `(1, 0)`
1377+
- `data/root/foo/baz/c1/0`
13711378

13721379

13731380

0 commit comments

Comments
 (0)