Skip to content

Commit edb65da

Browse files
committed
update migration guide
1 parent b85fa9b commit edb65da

File tree

4 files changed

+22
-17
lines changed

4 files changed

+22
-17
lines changed

docs/index.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,14 @@ Zarr is a file storage format for chunked, compressed, N-dimensional arrays base
5252
.. grid-item-card::
5353
:img-top: _static/index_user_guide.svg
5454

55-
Guide
56-
^^^^^
55+
Guide
56+
^^^^^
5757

58-
A detailed guide for how to use Zarr-Python.
58+
A detailed guide for how to use Zarr-Python.
5959

6060
+++
6161

62-
.. button-ref:: user-guide
63-
:ref-type: ref
62+
.. button-ref:: user-guide/index
6463
:expand:
6564
:color: dark
6665
:click-parent:

docs/user-guide/config.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Runtime configuration
44
=====================
55

6-
The :mod:`zarr.core.config` module is responsible for managing the configuration of zarr
7-
and is based on the `donfig <https://github.com/pytroll/donfig>`_ Python library.
6+
:mod:`zarr.config <zarr.core.config>` is responsible for managing the configuration of zarr and
7+
is based on the `donfig <https://github.com/pytroll/donfig>`_ Python library.
88

99
Configuration values can be set using code like the following::
1010

docs/user-guide/storage.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Zarr data (metadata and chunks) to a dictionary.:
9999
>>> zarr.create_array(store=store, shape=(2,), dtype='float64')
100100
<Array memory://... shape=(2,) dtype=float64>
101101

102+
.. _user-guide-custom-stores:
103+
102104
Developing custom stores
103105
------------------------
104106

docs/user-guide/v3_migration.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ The Array class
103103

104104
2. Defaulting to ``zarr_format=3`` - newly created arrays will use the version 3 of the
105105
Zarr specification. To continue using version 2, set ``zarr_format=2`` when creating arrays
106-
or set ``default_zarr_version=2`` in Zarr's :ref:`runtime configuration <config>`.
106+
or set ``default_zarr_version=2`` in Zarr's :ref:`runtime configuration <user-guide-config>`.
107107

108108
The Group class
109109
~~~~~~~~~~~~~~~
@@ -119,21 +119,25 @@ The Group class
119119
The Store class
120120
~~~~~~~~~~~~~~~
121121

122-
The Store API has changed significant in Zarr-Python 3. The most notable changes to the Store API are:
122+
The Store API has changed significant in Zarr-Python 3. The most notable changes to the
123+
Store API are:
123124

124125
1. Replaced the ``MutableMapping`` base class in favor of a custom abstract base class
125126
(:class:`zarr.abc.store.Store`).
126127
2. Switched to an asynchronous interface for all store methods that result in IO. This
127128
change ensures that all store methods are non-blocking and are as performant as
128129
possible.
129130

130-
Beyond the changes store interface, a number of deprecated stores were also removed in Zarr-Python 3.
131-
See :issue:`1274` for more details on the removal of these stores.
131+
Beyond the changes store interface, a number of deprecated stores were also removed in
132+
Zarr-Python 3. See :issue:`1274` for more details on the removal of these stores.
132133

133-
- ``N5Store`` - see https://github.com/zarr-developers/n5py for an alternative interface to N5 formatted data.
134-
- ``ABSStore`` - use the :class:`zarr.storage.FsspecStore` instead along with fsspec's `adlfs backend <https://github.com/fsspec/adlfs>`_.
135-
The following stores have been removed altogether. Users who need these stores
136-
will have to implement their own version in zarr-python v3.
134+
- ``N5Store`` - see https://github.com/zarr-developers/n5py for an alternative interface to
135+
N5 formatted data.
136+
- ``ABSStore`` - use the :class:`zarr.storage.FsspecStore` instead along with fsspec's
137+
`adlfs backend <https://github.com/fsspec/adlfs>`_.
138+
139+
The following stores have been removed altogether. Users who need these stores will have to
140+
implement their own version in zarr-python v3.
137141

138142
- ``DBMStore``
139143
- ``LMDBStore``
@@ -162,7 +166,7 @@ Configuration
162166
~~~~~~~~~~~~~
163167

164168
There is a new configuration system based on `donfig <https://github.com/pytroll/donfig>`_,
165-
which can be accessed via :mod:`zarr.config`.
169+
which can be accessed via ``zarr.config`` (see :ref:`user-guide-config` for more information)
166170
Configuration values can be set using code like the following:
167171

168172
.. code-block:: python
@@ -190,7 +194,7 @@ Miscellaneous
190194
been deprecated in favor of ``zarr_format``.
191195

192196
🚧 Work in Progress 🚧
193-
~~~~~~~~~~~~~~~~~~~~~~
197+
----------------------
194198

195199
Zarr-Python 3 is still under active development, and is not yet fully complete.
196200
The following list summarizes areas of the codebase that we expect to build out

0 commit comments

Comments
 (0)