Merge remote-tracking branch 'origin/main' into endian-to-bytes

normanrz · normanrz · commit 08eabab094fc · 2023-12-17T16:40:50.000+01:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Zarr Specs
+# Zarr Specification
 
 **Zarr core protocol for storage and retrieval of N-dimensional typed arrays**
 
diff --git a/docs/v3/codecs/blosc/v1.0.rst b/docs/v3/codecs/blosc/v1.0.rst
@@ -7,14 +7,13 @@
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/blosc/v1.0.html
 Corresponding ZEP:
-    `ZEP 1 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
+    `ZEP0001 — Zarr specification version 3 <https://zarr.dev/zeps/accepted/ZEP0001.html>`_
 Issue tracking:
     `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
 Suggest an edit for this spec:
     `GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/blosc/v1.0.rst>`_
 
-Copyright 2020 `Zarr core development team
-<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
+Copyright 2020-Present Zarr core development team. This work
 is licensed under a `Creative Commons Attribution 3.0 Unported License
 <https://creativecommons.org/licenses/by/3.0/>`_.
 
@@ -30,7 +29,7 @@ Defines a ``bytes -> bytes`` codec that uses the blosc container format.
 Status of this document
 =======================
 
-ZEP0001 was accepted on May 13th, 2023.
+ZEP0001 was accepted on May 15th, 2023 via https://github.com/zarr-developers/zarr-specs/issues/227.
 
 
 Document conventions
diff --git a/docs/v3/codecs/bytes/v1.0.rst b/docs/v3/codecs/bytes/v1.0.rst
@@ -9,14 +9,13 @@
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/bytes/v1.0.html
 Corresponding ZEP:
-    `ZEP 1 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
+    `ZEP0001 — Zarr specification version 3 <https://zarr.dev/zeps/accepted/ZEP0001.html>`_
 Issue tracking:
     `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
 Suggest an edit for this spec:
     `GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/bytes/v1.0.rst>`_
 
-Copyright 2020 `Zarr core development team
-<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
+Copyright 2020-Present Zarr core development team. This work
 is licensed under a `Creative Commons Attribution 3.0 Unported License
 <https://creativecommons.org/licenses/by/3.0/>`_.
 
@@ -34,7 +33,7 @@ types, it encodes the array either in little endian or big endian.
 Status of this document
 =======================
 
-ZEP0001 was accepted on May 13th, 2023.
+ZEP0001 was accepted on May 15th, 2023 via https://github.com/zarr-developers/zarr-specs/issues/227.
 
 
 Document conventions
diff --git a/docs/v3/codecs/crc32c/v1.0.rst b/docs/v3/codecs/crc32c/v1.0.rst
@@ -4,12 +4,14 @@
  CRC32C checksum codec (version 1.0)
 ============================
 
-  **Editor's draft 17 July 2023**
-
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/crc32c/v1.0.html
+Editors:
+    * Jonathan Striebel (`@jstriebel <https://github.com/jstriebel>`_), Scalable Minds
+    * Norman Rzepka (`@normanrz <https://github.com/normanrz>`_), Scalable Minds
+    * Jeremy Maitin-Shepard (`@jbms <https://github.com/jbms>`_), Google
 Corresponding ZEP:
-    `ZEP 2 — Sharding codec <https://zarr.dev/zeps/draft/ZEP0002.html>`_
+    `ZEP0002 — Sharding codec <https://zarr.dev/zeps/accepted/ZEP0002.html>`_
 Issue tracking:
     `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
 Suggest an edit for this spec:
@@ -32,13 +34,7 @@ Defines an ``bytes -> bytes`` codec that appends a CRC32C checksum of the input
 Status of this document
 =======================
 
-.. rst-class:: draft
-
-.. warning::
-    This document is a draft for review and subject to changes.
-    It will become final when the `Zarr Enhancement Proposal (ZEP) 2 <https://zarr.dev/zeps/draft/ZEP0002.html>`_
-    is approved via the `ZEP process <https://zarr.dev/zeps/active/ZEP0000.html>`_.
-
+ZEP0002 was accepted on November 1st, 2023 via https://github.com/zarr-developers/zarr-specs/issues/254.
 
 Document conventions
 ====================
diff --git a/docs/v3/codecs/gzip/v1.0.rst b/docs/v3/codecs/gzip/v1.0.rst
@@ -7,14 +7,13 @@
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/gzip/v1.0.html
 Corresponding ZEP:
-    `ZEP 1 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
+    `ZEP0001 — Zarr specification version 3 <https://zarr.dev/zeps/accepted/ZEP0001.html>`_
 Issue tracking:
     `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
 Suggest an edit for this spec:
     `GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/gzip/v1.0.rst>`_
 
-Copyright 2020 `Zarr core development team
-<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
+Copyright 2020-Present Zarr core development team. This work
 is licensed under a `Creative Commons Attribution 3.0 Unported License
 <https://creativecommons.org/licenses/by/3.0/>`_.
 
@@ -30,7 +29,7 @@ Defines a ``bytes -> bytes`` codec that applies gzip compression.
 Status of this document
 =======================
 
-ZEP0001 was accepted on May 13th, 2023.
+ZEP0001 was accepted on May 15th, 2023 via https://github.com/zarr-developers/zarr-specs/issues/227.
 
 
 Document conventions
diff --git a/docs/v3/codecs/sharding-indexed/v1.0.rst b/docs/v3/codecs/sharding-indexed/v1.0.rst
@@ -4,14 +4,16 @@
 Sharding codec (version 1.0)
 ==========================================
 
-  **Editor's draft 17 July 2023**
-
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/sharding-indexed/v1.0.html
+Editors:
+    * Jonathan Striebel (`@jstriebel <https://github.com/jstriebel>`_), Scalable Minds
+    * Norman Rzepka (`@normanrz <https://github.com/normanrz>`_), Scalable Minds
+    * Jeremy Maitin-Shepard (`@jbms <https://github.com/jbms>`_), Google
 Corresponding ZEP:
-    `ZEP 2 — Sharding codec <https://zarr.dev/zeps/draft/ZEP0002.html>`_
+    `ZEP0002 — Sharding codec <https://zarr.dev/zeps/accepted/ZEP0002.html>`_
 Issue tracking:
-    `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/sharding-indexed-codec-v1.0>`-
+    `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/sharding-indexed-codec-v1.0>`_
 Suggest an edit for this spec:
     `GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/codecs/sharding-indexed/v1.0.rst>`_
 
@@ -22,16 +24,6 @@ is licensed under a `Creative Commons Attribution 3.0 Unported License
 
 ----
 
-Status of this document
-=======================
-
-.. rst-class:: draft
-
-.. warning::
-    This document is a draft for review and subject to changes.
-    It will become final when the `Zarr Enhancement Proposal (ZEP) 2 <https://zarr.dev/zeps/draft/ZEP0002.html>`_
-    is approved via the `ZEP process <https://zarr.dev/zeps/active/ZEP0000.html>`_.
-
 
 Abstract
 ========
@@ -42,6 +34,10 @@ Sharding logically splits chunks ("shards") into sub-chunks ("inner chunks")
 that can be individually compressed and accessed. This allows to colocate 
 multiple chunks within one storage object, bundling them in shards.
 
+Status of this document
+======================
+
+ZEP0002 was accepted on November 1st, 2023 via https://github.com/zarr-developers/zarr-specs/issues/254.
 
 Motivation
 ==========
diff --git a/docs/v3/codecs/transpose/v1.0.rst b/docs/v3/codecs/transpose/v1.0.rst
@@ -9,14 +9,13 @@
 Specification URI:
     https://zarr-specs.readthedocs.io/en/latest/v3/codecs/transpose/v1.0.html
 Corresponding ZEP:
-    `ZEP 1 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
+    `ZEP0001 — Zarr specification version 3 <https://zarr.dev/zeps/draft/ZEP0001.html>`_
 Issue tracking:
     `GitHub issues <https://github.com/zarr-developers/zarr-specs/labels/codec>`_
 Suggest an edit for this spec:
     `GitHub editor <https://github.com/zarr-developers/zarr-specs/blob/main/docs/v3/codecs/transpose/v1.0.rst>`_
 
-Copyright 2020 `Zarr core development team
-<https://github.com/orgs/zarr-developers/teams/core-devs>`_. This work
+Copyright 2020-Present Zarr core development team. This work
 is licensed under a `Creative Commons Attribution 3.0 Unported License
 <https://creativecommons.org/licenses/by/3.0/>`_.
 
@@ -33,7 +32,7 @@ array.
 Status of this document
 =======================
 
-ZEP0001 was accepted on May 13th, 2023.
+ZEP0001 was accepted on May 15th, 2023 via https://github.com/zarr-developers/zarr-specs/issues/227.
 
 
 Document conventions
@@ -62,15 +61,9 @@ Configuration parameters
 ========================
 
 order:
-    Required.  Must be one of:
-
-    - An array of integers specifying a permutation of ``0``, ``1``, ...,
-      ``n-1``, where ``n`` is the number of dimensions in the decoded chunk
-      representation provided as input to this codec.
-    - The string ``"C"``, equivalent to specifying the identity permutation
-      ``0``, ``1``, ..., ``n-1``.  This makes the codec a no-op.
-    - The string ``"F"``, equivalent to specifying the permutation ``n-1``, ...,
-      ``1``, ``0``.
+    Required.  Must be an array of integers specifying a permutation of ``0``, ``1``, ...,
+    `n-1``, where ``n`` is the number of dimensions in the decoded chunk
+    representation provided as input to this codec.
 
 Format and algorithm
 ====================
@@ -102,4 +95,8 @@ References
 Change log
 ==========
 
-No changes yet.
+Changes after acceptance of ZEP 1
+---------------------------------
+
+The ``order`` configuration parameter no longer supports the constants ``"C"``
+or ``"F"`` and must instead always be specified as an explicit permutation.
diff --git a/docs/v3/core/v3.0.rst b/docs/v3/core/v3.0.rst
diff --git a/docs/v3/stores/filesystem/v1.0.rst b/docs/v3/stores/filesystem/v1.0.rst

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Zarr Specs`
	`1`	`+# Zarr Specification`
`2`	`2`
`3`	`3`	`Zarr core protocol for storage and retrieval of N-dimensional typed arrays`
`4`	`4`