Skip to content

Commit 455f853

Browse files
committed
Merge branch 'docs/3.0-migration' of https://github.com/zarr-developers/zarr-python into docs/3.0-migration
2 parents 8f2d18f + 175495b commit 455f853

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/user-guide/v3_migration.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The Group class
112112
1. Disallow direct construction - use :func:`zarr.open_group` or :func:`zarr.create_group`
113113
instead of directly constructing the :class:`zarr.Group` class.
114114
2. Most of the h5py compatibility methods are deprecated and will issue warnings if used.
115-
The following migration is suggested:
115+
The following functions are drop in replacements that have the same signature and functionality:
116116

117117
- Use :func:`zarr.Group.create_array` in place of :func:`zarr.Group.create_dataset`
118118
- Use :func:`zarr.Group.require_array` in place of :func:`zarr.Group.require_dataset`
@@ -134,6 +134,9 @@ See :issue:`1274` for more details on the removal of these stores.
134134

135135
- ``N5Store`` - see https://github.com/zarr-developers/n5py for an alternative interface to N5 formatted data.
136136
- ``ABSStore`` - use the :class:`zarr.storage.FsspecStore` instead along with fsspec's `adlfs backend <https://github.com/fsspec/adlfs>`_.
137+
The following stores have been removed altogether. Users who need these stores
138+
will have to implement their own version in zarr-python v3.
139+
137140
- ``DBMStore``
138141
- ``LMDBStore``
139142
- ``SQLiteStore``
@@ -204,7 +207,7 @@ Zarr-Python, please open (or comment on) a
204207
* :func:`zarr.copy_store` (:issue:`2407`)
205208
* :func:`zarr.Group.move` (:issue:`2108`)
206209

207-
- The following options in the top-level API (i.e. creation and convenience functions in
210+
- The following features (corresponding to function arguments to functions in
208211
:mod:`zarr`) have not been ported to Zarr-Python 3 yet.
209212

210213
* ``cache_attrs``

0 commit comments

Comments
 (0)