Skip to content

Commit cb161fd

Browse files
committed
docs: align async codec parameter docs
1 parent 638ac3a commit cb161fd

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

‎src/zarr/core/array.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4632,7 +4632,11 @@ async def create_array(
46324632
filters are applied (if any are specified) and the data is serialized into bytes.
46334633
46344634
For Zarr format 3, a "compressor" is a codec that takes a bytestream, and
4635-
returns another bytestream. Multiple compressors may be provided for Zarr format 3.
4635+
returns another bytestream. These values must be instances of
4636+
[`zarr.abc.codec.BytesBytesCodec`][], or dict representations of
4637+
[`zarr.abc.codec.BytesBytesCodec`][]. Multiple compressors may be provided
4638+
for Zarr format 3. Codecs that take an array and return bytes are serializers
4639+
and must be supplied with ``serializer`` instead.
46364640
If no ``compressors`` are provided, a default set of compressors will be used.
46374641
These defaults can be changed by modifying the value of ``array.v3_default_compressors``
46384642
in [`zarr.config`][zarr.config].
@@ -4646,6 +4650,8 @@ async def create_array(
46464650
serializer : dict[str, JSON] | ArrayBytesCodec, optional
46474651
Array-to-bytes codec to use for encoding the array data.
46484652
Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion.
4653+
Codecs that are instances of [`zarr.abc.codec.ArrayBytesCodec`][] must be
4654+
supplied here, not with ``compressors``.
46494655
If no ``serializer`` is provided, a default serializer will be used.
46504656
These defaults can be changed by modifying the value of ``array.v3_default_serializer``
46514657
in [`zarr.config`][zarr.config].

0 commit comments

Comments
 (0)