Skip to content

Commit 29ce9dc

Browse files
committed
add change notes to spec
1 parent 3eeb02a commit 29ce9dc

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

docs/spec/v2.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,9 +466,29 @@ What has been stored::
466466
Changes
467467
-------
468468

469+
Version 2 clarifications
470+
~~~~~~~~~~~~~~~~~~~~~~~~
471+
472+
The following changes have been made to the version 2 specification since it was
473+
initially published to clarify ambiguities and add some missing information.
474+
475+
* The specification now describes how bytes fill values should be encoded and
476+
decoded for arrays with a fixed-length byte string data type (:issue:`165`,
477+
:issue:`176`).
478+
479+
* The specification now clarifies that datetime64 and timedelta64 data types are not
480+
supported in this version (:issue:`85`).
481+
482+
* The specification now clarifies that the '.zattrs' key does not have to be present for
483+
either arrays or groups, and if absent then custom attributes should be treated as
484+
empty.
485+
486+
469487
Changes in version 2
470488
~~~~~~~~~~~~~~~~~~~~
471489

490+
The following changes were made between version 1 and version 2 of this specification:
491+
472492
* Added support for storing multiple arrays in the same store and organising
473493
arrays into hierarchies using groups.
474494
* Array metadata is now stored under the ".zarray" key instead of the "meta"

zarr/storage.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1472,7 +1472,9 @@ def _lmdb_decode_key_bytes(key):
14721472

14731473

14741474
class LMDBStore(MutableMapping):
1475-
"""Storage class using LMDB.
1475+
"""Storage class using LMDB. Requires the `lmdb <http://lmdb.readthedocs.io/>`_
1476+
package to be installed.
1477+
14761478
14771479
Parameters
14781480
----------
@@ -1484,10 +1486,6 @@ class LMDBStore(MutableMapping):
14841486
**kwargs
14851487
Keyword arguments passed through to the `lmdb.open` function.
14861488
1487-
Notes
1488-
-----
1489-
Requires the `lmdb <http://lmdb.readthedocs.io/>`_ package to be installed.
1490-
14911489
Examples
14921490
--------
14931491
Store a single array::

0 commit comments

Comments
 (0)