Skip to content

Commit a4cb904

Browse files
authored
Merge branch 'main' into chunk-key-encoding
2 parents aba7f25 + 0790546 commit a4cb904

File tree

6 files changed

+15
-425
lines changed

6 files changed

+15
-425
lines changed
73.9 KB
Loading
14 KB
Loading

docs/v3/core/v3.0.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1078,8 +1078,8 @@ compressed using gzip compression prior to storage::
10781078
}
10791079
}
10801080

1081-
The following example illustrates an array with the same shape and
1082-
chunking as above, but using an extension data type::
1081+
The following example illustrates an array with the same shape and chunking as
1082+
above, but using a (currently made up) extension data type::
10831083

10841084
{
10851085
"zarr_format": 3,
@@ -1143,11 +1143,6 @@ A Zarr group metadata object must contain the following mandatory key:
11431143

11441144
Optional keys:
11451145

1146-
``storage_transformers`` (group)
1147-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1148-
1149-
TBD
1150-
11511146
``attributes``
11521147
^^^^^^^^^^^^^^
11531148

@@ -1585,6 +1580,10 @@ by the Array. Storage transformers can be configured per array via the
15851580
not change the storage layout (e.g. for caching) may be specified at runtime without
15861581
adding them to the array metadata.
15871582

1583+
.. note::
1584+
It is planned to add storage transformers also to groups in a later revision
1585+
of this spec, see https://github.com/zarr-developers/zarr-specs/issues/215.
1586+
15881587
A storage transformer serves the same `abstract store interface`_ as the store_.
15891588
However, it should not persistently store any information necessary to restore the original data,
15901589
but instead propagates this to the next storage transformer or the final store.
@@ -1627,7 +1626,6 @@ array chunk grid `chunk_grid`_
16271626
array chunk key encoding `chunk_key_encoding`_
16281627
array codecs `codecs`_
16291628
array storage transformer `storage_transformers (array)`_
1630-
group storage transformer `storage_transformers (group)`_
16311629
=========== ======================= ================================================
16321630

16331631
If such extension points are used by groups or arrays, they are required, except
@@ -1636,9 +1634,17 @@ for data types specifying fallback data types.
16361634
See https://github.com/zarr-developers/zarr-specs/issues/49 for a list of
16371635
potential extensions.
16381636

1637+
Specifications for new extensions are recommended to be published in the
1638+
https://github.com/zarr-developers/zarr-specs repository via the
1639+
`ZEP process <https://zarr.dev/zeps/active/ZEP0000.html>`_. If a specification
1640+
is published decentralized (e.g. for initial experimentation or due to a very
1641+
specialized scope), it must use a URL in the `name` key of its metadata, which
1642+
identifies the publishing organization or individual, and should point to the
1643+
specification of the extension.
1644+
16391645
Future versions of this specification may also add new core features by adding new top-level
16401646
metadata keys. Such features are required by default. However, if the value of an unknown feature
1641-
is an object containing the key-value pair ```"must_understand": false``, it can be ignored.
1647+
is an object containing the key-value pair ``"must_understand": false``, it can be ignored.
16421648

16431649
Implementation Notes
16441650
====================

docs/v3/data-types/datetime/v1.0.rst

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

docs/v3/data-types/string/v1.0.rst

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

0 commit comments

Comments
 (0)