Skip to content

Commit

Permalink
make compressor optional (zarr-developers#94)
Browse files Browse the repository at this point in the history
  • Loading branch information
Carreau authored Sep 25, 2020
1 parent d1cc620 commit 40f4944
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions docs/protocol/core/v3.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,7 @@ Array metadata

Each Zarr array in a hierarchy must have an array metadata
document. This document must contain a single object with the
following names:
following mandatory names:

``shape``

Expand Down Expand Up @@ -856,15 +856,6 @@ following names:
human-readable representation of the specification. The ``type`` is
required and the value is defined by the protocol extension.

``compressor``

Specifies a codec to be used for encoding and decoding chunks. The
value must be an object containing the name ``codec`` whose value
is a URI that identifies a codec and dereferences to a human
readable representation of the codec specification. The codec
object may also contain a ``configuration`` name whose value is
defined by the corresponding codec specification.

``fill_value``

Provides an element value to use for uninitialised portions of the
Expand Down Expand Up @@ -902,6 +893,19 @@ following names:
The value must be an object. The object may contain any name/value
pairs.

The following names are optional:

``compressor``

Specifies a codec to be used for encoding and decoding chunks. The
value must be an object containing the name ``codec`` whose value
is a URI that identifies a codec and dereferences to a human
readable representation of the codec specification. The codec
object may also contain a ``configuration`` name whose value is
defined by the corresponding codec specification. When the key for this is
absent, this signor fies that no compressor has been used.


All other names within the array metadata object are reserved for
future versions of this specification.

Expand Down

0 comments on commit 40f4944

Please sign in to comment.