correct code double backticks

scalableminds · Dec 18, 2024 · 083c4cb · 083c4cb
1 parent 48c7448
commit 083c4cb
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 41 deletions.
diff --git a/src/zarr/api/asynchronous.py b/src/zarr/api/asynchronous.py
@@ -836,17 +836,17 @@ async def create(
         this collection specify the transformation from array values to stored bytes.
         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`.
-        - For bytes or objects, the default is `VLenBytesCodec`.
+        - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+        - For Unicode strings, the default is ``VLenUTF8Codec``.
+        - For bytes or objects, the default is ``VLenBytesCodec``.
         These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
     compressor : Codec, 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:
-        - For numeric arrays, the default is `ZstdCodec`.
-        - For Unicode strings, the default is `VLenUTF8Codec`.
-        - For bytes or objects, the default is `VLenBytesCodec`.
+        - For numeric arrays, the default is ``ZstdCodec``.
+        - For Unicode strings, the default is ``VLenUTF8Codec``.
+        - For bytes or objects, the default is ``VLenBytesCodec``.
         These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
     fill_value : object
         Default value to use for uninitialized portions of the array.

diff --git a/src/zarr/core/array.py b/src/zarr/core/array.py
@@ -421,16 +421,16 @@ async def create(
             this collection specify the transformation from array values to stored bytes.
             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`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
         dimension_names : Iterable[str], optional
             The names of the dimensions (default is None).
             V3 only. V2 arrays should not use this parameter.
         chunks : ShapeLike, optional
             The shape of the array's chunks.
-            V2 only. V3 arrays should use `chunk_shape` instead.
+            V2 only. V3 arrays should use :func:`chunk_shape` instead.
             If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"], optional
             The dimension separator (default is ".").
@@ -446,9 +446,9 @@ async def create(
             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:
-            - For numeric arrays, the default is `ZstdCodec`.
-            - For Unicode strings, the default is `VLenUTF8Codec`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
         overwrite : bool, optional
             Whether to raise an error if the store already exists (default is False).
@@ -1513,16 +1513,16 @@ def create(
             this collection specify the transformation from array values to stored bytes.
             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`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
         dimension_names : Iterable[str], optional
             The names of the dimensions (default is None).
             V3 only. V2 arrays should not use this parameter.
         chunks : ChunkCoords, optional
             The shape of the array's chunks.
-            V2 only. V3 arrays should use `chunk_shape` instead.
+            V2 only. V3 arrays should use :func:`chunk_shape` instead.
             If not specified, default are guessed based on the shape and dtype.
         dimension_separator : Literal[".", "/"], optional
             The dimension separator (default is ".").
@@ -1538,9 +1538,9 @@ def create(
             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:
-            - For numeric arrays, the default is `ZstdCodec`.
-            - For Unicode strings, the default is `VLenUTF8Codec`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
         overwrite : bool, optional
             Whether to raise an error if the store already exists (default is False).

diff --git a/src/zarr/core/group.py b/src/zarr/core/group.py
@@ -1046,15 +1046,15 @@ async def create_array(
             this collection specify the transformation from array values to stored bytes.
             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`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
         dimension_names : Iterable[str] | None = None
             The names of the dimensions of the array. V3 only.
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
-            V2 only. V3 arrays should use `chunk_shape` instead.
+            V2 only. V3 arrays should use :func:`chunk_shape` instead.
             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: ".")
@@ -1070,9 +1070,9 @@ async def create_array(
             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:
-            - For numeric arrays, the default is `ZstdCodec`.
-            - For Unicode strings, the default is `VLenUTF8Codec`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
         overwrite : bool = False
             If True, a pre-existing array or group at the path of this array will
@@ -2267,15 +2267,15 @@ def create_array(
             this collection specify the transformation from array values to stored bytes.
             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`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
         dimension_names : Iterable[str] | None = None
             The names of the dimensions of the array. V3 only.
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
-            V2 only. V3 arrays should use `chunk_shape` instead.
+            V2 only. V3 arrays should use :func:`chunk_shape` instead.
             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: ".")
@@ -2291,9 +2291,9 @@ def create_array(
             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:
-            - For numeric arrays, the default is `ZstdCodec`.
-            - For Unicode strings, the default is `VLenUTF8Codec`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
         overwrite : bool = False
             If True, a pre-existing array or group at the path of this array will
@@ -2631,15 +2631,15 @@ def array(
             this collection specify the transformation from array values to stored bytes.
             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`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
         dimension_names : Iterable[str] | None = None
             The names of the dimensions of the array. V3 only.
         chunks : ChunkCoords | None = None
             The shape of the chunks of the array.
-            V2 only. V3 arrays should use `chunk_shape` instead.
+            V2 only. V3 arrays should use :func:`chunk_shape` instead.
             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: ".")
@@ -2655,9 +2655,9 @@ def array(
             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:
-            - For numeric arrays, the default is `ZstdCodec`.
-            - For Unicode strings, the default is `VLenUTF8Codec`.
-            - For bytes or objects, the default is `VLenBytesCodec`.
+            - For numeric arrays, the default is ``ZstdCodec``.
+            - For Unicode strings, the default is ``VLenUTF8Codec``.
+            - For bytes or objects, the default is ``VLenBytesCodec``.
             These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
         overwrite : bool = False
             If True, a pre-existing array or group at the path of this array will