Skip to content

Commit 7dbbe70

Browse files
committed
Improve migration guide for codecs
1 parent abbdbf2 commit 7dbbe70

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

changes/3273.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add a section on codecs to the migration guide.

docs/user-guide/v3_migration.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ the following actions in order:
5858
vendor the parts of the specific modules that you need.
5959

6060
* ``zarr.attrs`` has gone, with no replacement
61-
* ``zarr.codecs`` has gone, use ``numcodecs`` instead
61+
* ``zarr.codecs`` has changed, see "Codecs" section below for more information
6262
* ``zarr.context`` has gone, with no replacement
6363
* ``zarr.core`` remains but should be considered private API
6464
* ``zarr.hierarchy`` has gone, with no replacement (use ``zarr.Group`` inplace of ``zarr.hierarchy.Group``)
@@ -178,6 +178,18 @@ If you are interested in developing a custom store that targets these backends,
178178
:ref:`developing custom stores <user-guide-custom-stores>` or open an
179179
`issue <https://github.com/zarr-developers/zarr-python/issues>`_ to discuss your use case.
180180

181+
182+
Codecs
183+
~~~~~~
184+
Codecs defined in ``numcodecs`` (and also imported into the ``zarr.codecs`` namespace in Zarr-Python 2)
185+
should still be used when creating Zarr format 2 arrays.
186+
187+
Codecs for creating Zarr format 3 arrays are available in two locations:
188+
189+
- `zarr.codecs` contains Zarr format 3 codecs that are defined in the `codecs section of the Zarr format 3 specification <https://zarr-specs.readthedocs.io/en/latest/v3/codecs/index.html>`_.
190+
- `numcodecs.zarr3` contains codecs from ``numcodecs`` that can be used to create Zarr format 3 arrays, but are not necessarily part of the Zarr format 3 specification.
191+
192+
181193
Dependencies
182194
~~~~~~~~~~~~
183195

0 commit comments

Comments
 (0)