apply suggestions from review

Author: brokkoli71

src/zarr/api/asynchronous.py

@@ -834,7 +834,7 @@ async def create(
     codecs : Sequence of Codecs or dicts, optional
         An iterable of Codec or dict serializations of Codecs. The elements of
         this collection specify the transformation from array values to stored bytes.
-        V3 only. V2 arrays should use `filters` and `compressor` instead.
+        V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
         If no codecs are provided, default codecs will be used:
         - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
         - For Unicode strings, the default is `VLenUTF8Codec`.

src/zarr/core/array.py

@@ -411,15 +411,15 @@ async def create(
         chunk_shape : ChunkCoords, optional
             The shape of the array's chunks
             V3 only. V2 arrays should use `chunks` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         chunk_key_encoding : ChunkKeyEncoding, optional
             A specification of how the chunk keys are represented in storage.
             V3 only. V2 arrays should use `dimension_separator` instead.
-            Default is ("default", "/").
+            Default is ``("default", "/")``.
         codecs : Sequence of Codecs or dicts, optional
-            An iterable of Codec or dict serializations thereof. The elements of
+            An iterable of Codec or dict serializations of Codecs. The elements of
             this collection specify the transformation from array values to stored bytes.
-            V3 only. V2 arrays should use `filters` and `compressor` instead.
+            V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
             If no codecs are provided, default codecs will be used:
             - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
@@ -431,21 +431,21 @@ async def create(
         chunks : ShapeLike, optional
             The shape of the array's chunks.
             V2 only. V3 arrays should use `chunk_shape` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"], optional
             The dimension separator (default is ".").
-            V2 only. V3 arrays should use `chunk_key_encoding` instead.
+            V2 only. V3 arrays should use ``chunk_key_encoding`` instead.
         order : Literal["C", "F"], optional
             The order of the array (default is specified in the Zarr config `array.order`).
         filters : list[dict[str, JSON]], optional
             Sequence of filters to use to encode chunk data prior to compression.
-            V2 only. V3 arrays should use `codecs` instead. If neither `compressor`
-            nor `filters` are provided, a default compressor will be used. (see
-            `compressor` for details)
+            V2 only. V3 arrays should use ``codecs`` instead. If neither ``compressor``
+            nor ``filters`` are provided, a default compressor will be used. (see
+            ``compressor`` for details)
         compressor : dict[str, JSON], optional
             The compressor used to compress the data (default is None).
-            V2 only. V3 arrays should use `codecs` instead.
-            If neither `compressor` nor `filters` are provided, a default compressor will be used:
+            V2 only. V3 arrays should use ``codecs`` instead.
+            If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
             - For numeric arrays, the default is `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
             - For bytes or objects, the default is `VLenBytesCodec`.
@@ -1503,15 +1503,15 @@ def create(
         chunk_shape : ChunkCoords, optional
             The shape of the Array's chunks.
             V3 only. V2 arrays should use `chunks` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         chunk_key_encoding : ChunkKeyEncoding, optional
             A specification of how the chunk keys are represented in storage.
             V3 only. V2 arrays should use `dimension_separator` instead.
-            Default is ("default", "/").
+            Default is ``("default", "/")``.
         codecs : Sequence of Codecs or dicts, optional
-            An iterable of Codec or dict serializations thereof. The elements of
+            An iterable of Codec or dict serializations of Codecs. The elements of
             this collection specify the transformation from array values to stored bytes.
-            V3 only. V2 arrays should use `filters` and `compressor` instead.
+            V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
             If no codecs are provided, default codecs will be used:
             - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
@@ -1523,21 +1523,21 @@ def create(
         chunks : ChunkCoords, optional
             The shape of the array's chunks.
             V2 only. V3 arrays should use `chunk_shape` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"], optional
             The dimension separator (default is ".").
-            V2 only. V3 arrays should use `chunk_key_encoding` instead.
+            V2 only. V3 arrays should use ``chunk_key_encoding`` instead.
         order : Literal["C", "F"], optional
             The order of the array (default is specified in the Zarr config `array.order`).
         filters : list[dict[str, JSON]], optional
             Sequence of filters to use to encode chunk data prior to compression.
-            V2 only. V3 arrays should use `codecs` instead. If neither `compressor`
-            nor `filters` are provided, a default compressor will be used. (see
-            `compressor` for details)
+            V2 only. V3 arrays should use ``codecs`` instead. If neither ``compressor``
+            nor ``filters`` are provided, a default compressor will be used. (see
+            ``compressor`` for details)
         compressor : dict[str, JSON], optional
             Primary compressor to compress chunk data.
-            V2 only. V3 arrays should use `codecs` instead.
-            If neither `compressor` nor `filters` are provided, a default compressor will be used:
+            V2 only. V3 arrays should use ``codecs`` instead.
+            If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
             - For numeric arrays, the default is `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
             - For bytes or objects, the default is `VLenBytesCodec`.

src/zarr/core/group.py

@@ -1036,15 +1036,15 @@ async def create_array(
         chunk_shape : tuple[int, ...] | None = None
             The shape of the chunks of the array.
             V3 only. V2 arrays should use `chunks` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         chunk_key_encoding : ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None = None
             A specification of how the chunk keys are represented in storage.
             V3 only. V2 arrays should use `dimension_separator` instead.
-            Default is ("default", "/").
+            Default is ``("default", "/")``.
         codecs : Iterable[Codec | dict[str, JSON]] | None = None
-            An iterable of Codec or dict serializations thereof. The elements of
+            An iterable of Codec or dict serializations of Codecs. The elements of
             this collection specify the transformation from array values to stored bytes.
-            V3 only. V2 arrays should use `filters` and `compressor` instead.
+            V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
             If no codecs are provided, default codecs will be used:
             - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
@@ -1055,21 +1055,21 @@ async def create_array(
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
             V2 only. V3 arrays should use `chunk_shape` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"] | None = None
             The delimiter used for the chunk keys. (default: ".")
-            V2 only. V3 arrays should use `chunk_key_encoding` instead.
+            V2 only. V3 arrays should use ``chunk_key_encoding`` instead.
         order : Literal["C", "F"] | None = None
             The memory order of the array (default is specified in the Zarr config `array.order`).
         filters : list[dict[str, JSON]] | None = None
             Sequence of filters to use to encode chunk data prior to compression.
-            V2 only. V3 arrays should use `codecs` instead. If neither `compressor`
-            nor `filters` are provided, a default compressor will be used. (see
-            `compressor` for details)
+            V2 only. V3 arrays should use ``codecs`` instead. If neither ``compressor``
+            nor ``filters`` are provided, a default compressor will be used. (see
+            ``compressor`` for details)
         compressor : dict[str, JSON] | None = None
             The compressor used to compress the data (default is None).
-            V2 only. V3 arrays should use `codecs` instead.
-            If neither `compressor` nor `filters` are provided, a default compressor will be used:
+            V2 only. V3 arrays should use ``codecs`` instead.
+            If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
             - For numeric arrays, the default is `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
             - For bytes or objects, the default is `VLenBytesCodec`.
@@ -2257,15 +2257,15 @@ def create_array(
         chunk_shape : tuple[int, ...] | None = None
             The shape of the chunks of the array.
             V3 only. V2 arrays should use `chunks` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         chunk_key_encoding : ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None = None
             A specification of how the chunk keys are represented in storage.
             V3 only. V2 arrays should use `dimension_separator` instead.
-            Default is ("default", "/").
+            Default is ``("default", "/")``.
         codecs : Iterable[Codec | dict[str, JSON]] | None = None
-            An iterable of Codec or dict serializations thereof. The elements of
+            An iterable of Codec or dict serializations of Codecs. The elements of
             this collection specify the transformation from array values to stored bytes.
-            V3 only. V2 arrays should use `filters` and `compressor` instead.
+            V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
             If no codecs are provided, default codecs will be used:
             - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
@@ -2276,21 +2276,21 @@ def create_array(
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
             V2 only. V3 arrays should use `chunk_shape` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"] | None = None
             The delimiter used for the chunk keys. (default: ".")
-            V2 only. V3 arrays should use `chunk_key_encoding` instead.
+            V2 only. V3 arrays should use ``chunk_key_encoding`` instead.
         order : Literal["C", "F"] | None = None
             The memory order of the array (default is specified in the Zarr config `array.order`).
         filters : list[dict[str, JSON]] | None = None
             Sequence of filters to use to encode chunk data prior to compression.
-            V2 only. V3 arrays should use `codecs` instead. If neither `compressor`
-            nor `filters` are provided, a default compressor will be used. (see
-            `compressor` for details)
+            V2 only. V3 arrays should use ``codecs`` instead. If neither ``compressor``
+            nor ``filters`` are provided, a default compressor will be used. (see
+            ``compressor`` for details)
         compressor : dict[str, JSON] | None = None
             The compressor used to compress the data (default is None).
-            V2 only. V3 arrays should use `codecs` instead.
-            If neither `compressor` nor `filters` are provided, a default compressor will be used:
+            V2 only. V3 arrays should use ``codecs`` instead.
+            If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
             - For numeric arrays, the default is `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
             - For bytes or objects, the default is `VLenBytesCodec`.
@@ -2621,15 +2621,15 @@ def array(
         chunk_shape : tuple[int, ...] | None = None
             The shape of the chunks of the array.
             V3 only. V2 arrays should use `chunks` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         chunk_key_encoding : ChunkKeyEncoding | tuple[Literal["default"], Literal[".", "/"]] | tuple[Literal["v2"], Literal[".", "/"]] | None = None
             A specification of how the chunk keys are represented in storage.
             V3 only. V2 arrays should use `dimension_separator` instead.
-            Default is ("default", "/").
+            Default is ``("default", "/")``.
         codecs : Iterable[Codec | dict[str, JSON]] | None = None
-            An iterable of Codec or dict serializations thereof. The elements of
+            An iterable of Codec or dict serializations of Codecs. The elements of
             this collection specify the transformation from array values to stored bytes.
-            V3 only. V2 arrays should use `filters` and `compressor` instead.
+            V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
             If no codecs are provided, default codecs will be used:
             - For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
@@ -2640,21 +2640,21 @@ def array(
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
             V2 only. V3 arrays should use `chunk_shape` instead.
-            Default values are guessed based on the shape and dtype.
+            If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"] | None = None
             The delimiter used for the chunk keys. (default: ".")
-            V2 only. V3 arrays should use `chunk_key_encoding` instead.
+            V2 only. V3 arrays should use ``chunk_key_encoding`` instead.
         order : Literal["C", "F"] | None = None
             The memory order of the array (default is specified in the Zarr config `array.order`).
         filters : list[dict[str, JSON]] | None = None
             Sequence of filters to use to encode chunk data prior to compression.
-            V2 only. V3 arrays should use `codecs` instead. If neither `compressor`
-            nor `filters` are provided, a default compressor will be used. (see
-            `compressor` for details)
+            V2 only. V3 arrays should use ``codecs`` instead. If neither ``compressor``
+            nor ``filters`` are provided, a default compressor will be used. (see
+            ``compressor`` for details)
         compressor : dict[str, JSON] | None = None
             The compressor used to compress the data (default is None).
-            V2 only. V3 arrays should use `codecs` instead.
-            If neither `compressor` nor `filters` are provided, a default compressor will be used:
+            V2 only. V3 arrays should use ``codecs`` instead.
+            If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
             - For numeric arrays, the default is `ZstdCodec`.
             - For Unicode strings, the default is `VLenUTF8Codec`.
             - For bytes or objects, the default is `VLenBytesCodec`.

tests/test_v2.py

@@ -203,7 +203,7 @@ def test_v2_non_contiguous(array_order: Literal["C", "F"], data_order: Literal["
 
 
 def test_default_compressor_deprecation_warning():
-    with pytest.warns(DeprecationWarning):
+    with pytest.warns(DeprecationWarning, match="default_compressor is deprecated"):
         zarr.storage.default_compressor = "zarr.codecs.zstd.ZstdCodec()"