Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make compressor key optional for when no compression is used. #94

Merged
merged 1 commit into from
Sep 25, 2020
Merged

Make compressor key optional for when no compression is used. #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/protocol/core/v3.0.rst
View file
Open in desktop
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