Skip to content

Commit 134cd41

Browse files
committed
move note up
1 parent 0f2405f commit 134cd41

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/user-guide/extending.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,18 @@ in the following ways:
99
Custom codecs
1010
-------------
1111

12+
.. note::
13+
This section explains how custom codecs can be created for Zarr version 3 data. For Zarr
14+
version 2, codecs should subclass the
15+
`numcodecs.abc.Codec <https://numcodecs.readthedocs.io/en/stable/abc.html#numcodecs.abc.Codec>`_
16+
base class and register through
17+
`numcodecs.registry.register_codec <https://numcodecs.readthedocs.io/en/stable/registry.html#numcodecs.registry.register_codec>`_.
18+
1219
There are three types of codecs in Zarr:
1320
- array-to-array
1421
- array-to-bytes
15-
- bytes-to-bytes.
22+
- bytes-to-bytes
23+
1624
Array-to-array codecs are used to transform the array data before serializing
1725
to bytes. Examples include delta encoding or scaling codecs. Array-to-bytes codecs are used
1826
for serializing the array data to bytes. In Zarr, the main codec to use for numeric arrays
@@ -67,13 +75,6 @@ useful for providing specialized implementations, such as GPU-based codecs. In c
6775
multiple codecs, the :mod:`zarr.core.config` mechanism can be used to select the preferred
6876
implementation.
6977

70-
.. note::
71-
This section explains how custom codecs can be created for Zarr version 3 data. For Zarr
72-
version 2, codecs should subclass the
73-
`numcodecs.abc.Codec <https://numcodecs.readthedocs.io/en/stable/abc.html#numcodecs.abc.Codec>`_
74-
base class and register through
75-
`numcodecs.registry.register_codec <https://numcodecs.readthedocs.io/en/stable/registry.html#numcodecs.registry.register_codec>`_.
76-
7778
Custom stores
7879
-------------
7980

0 commit comments

Comments
 (0)