Skip to content

Commit 083c4cb

Browse files
brokkoli71brokkoli71
committed
correct code double backticks
1 parent 48c7448 commit 083c4cb

File tree

3 files changed

+41
-41
lines changed

3 files changed

+41
-41
lines changed

‎src/zarr/api/asynchronous.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -836,17 +836,17 @@ async def create(
836836
this collection specify the transformation from array values to stored bytes.
837837
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
838838
If no codecs are provided, default codecs will be used:
839-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
840-
- For Unicode strings, the default is `VLenUTF8Codec`.
841-
- For bytes or objects, the default is `VLenBytesCodec`.
839+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
840+
- For Unicode strings, the default is ``VLenUTF8Codec``.
841+
- For bytes or objects, the default is ``VLenBytesCodec``.
842842
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
843843
compressor : Codec, optional
844844
Primary compressor to compress chunk data.
845845
V2 only. V3 arrays should use ``codecs`` instead.
846846
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
847-
- For numeric arrays, the default is `ZstdCodec`.
848-
- For Unicode strings, the default is `VLenUTF8Codec`.
849-
- For bytes or objects, the default is `VLenBytesCodec`.
847+
- For numeric arrays, the default is ``ZstdCodec``.
848+
- For Unicode strings, the default is ``VLenUTF8Codec``.
849+
- For bytes or objects, the default is ``VLenBytesCodec``.
850850
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
851851
fill_value : object
852852
Default value to use for uninitialized portions of the array.

‎src/zarr/core/array.py‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -421,16 +421,16 @@ async def create(
421421
this collection specify the transformation from array values to stored bytes.
422422
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
423423
If no codecs are provided, default codecs will be used:
424-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
425-
- For Unicode strings, the default is `VLenUTF8Codec`.
426-
- For bytes or objects, the default is `VLenBytesCodec`.
424+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
425+
- For Unicode strings, the default is ``VLenUTF8Codec``.
426+
- For bytes or objects, the default is ``VLenBytesCodec``.
427427
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
428428
dimension_names : Iterable[str], optional
429429
The names of the dimensions (default is None).
430430
V3 only. V2 arrays should not use this parameter.
431431
chunks : ShapeLike, optional
432432
The shape of the array's chunks.
433-
V2 only. V3 arrays should use `chunk_shape` instead.
433+
V2 only. V3 arrays should use :func:`chunk_shape` instead.
434434
If not specified, default are guessed based on the shape and dtype.
435435
dimension_separator : Literal[".", "/"], optional
436436
The dimension separator (default is ".").
@@ -446,9 +446,9 @@ async def create(
446446
The compressor used to compress the data (default is None).
447447
V2 only. V3 arrays should use ``codecs`` instead.
448448
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
449-
- For numeric arrays, the default is `ZstdCodec`.
450-
- For Unicode strings, the default is `VLenUTF8Codec`.
451-
- For bytes or objects, the default is `VLenBytesCodec`.
449+
- For numeric arrays, the default is ``ZstdCodec``.
450+
- For Unicode strings, the default is ``VLenUTF8Codec``.
451+
- For bytes or objects, the default is ``VLenBytesCodec``.
452452
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
453453
overwrite : bool, optional
454454
Whether to raise an error if the store already exists (default is False).
@@ -1513,16 +1513,16 @@ def create(
15131513
this collection specify the transformation from array values to stored bytes.
15141514
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
15151515
If no codecs are provided, default codecs will be used:
1516-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
1517-
- For Unicode strings, the default is `VLenUTF8Codec`.
1518-
- For bytes or objects, the default is `VLenBytesCodec`.
1516+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
1517+
- For Unicode strings, the default is ``VLenUTF8Codec``.
1518+
- For bytes or objects, the default is ``VLenBytesCodec``.
15191519
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
15201520
dimension_names : Iterable[str], optional
15211521
The names of the dimensions (default is None).
15221522
V3 only. V2 arrays should not use this parameter.
15231523
chunks : ChunkCoords, optional
15241524
The shape of the array's chunks.
1525-
V2 only. V3 arrays should use `chunk_shape` instead.
1525+
V2 only. V3 arrays should use :func:`chunk_shape` instead.
15261526
If not specified, default are guessed based on the shape and dtype.
15271527
dimension_separator : Literal[".", "/"], optional
15281528
The dimension separator (default is ".").
@@ -1538,9 +1538,9 @@ def create(
15381538
Primary compressor to compress chunk data.
15391539
V2 only. V3 arrays should use ``codecs`` instead.
15401540
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
1541-
- For numeric arrays, the default is `ZstdCodec`.
1542-
- For Unicode strings, the default is `VLenUTF8Codec`.
1543-
- For bytes or objects, the default is `VLenBytesCodec`.
1541+
- For numeric arrays, the default is ``ZstdCodec``.
1542+
- For Unicode strings, the default is ``VLenUTF8Codec``.
1543+
- For bytes or objects, the default is ``VLenBytesCodec``.
15441544
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
15451545
overwrite : bool, optional
15461546
Whether to raise an error if the store already exists (default is False).

‎src/zarr/core/group.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,15 +1046,15 @@ async def create_array(
10461046
this collection specify the transformation from array values to stored bytes.
10471047
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
10481048
If no codecs are provided, default codecs will be used:
1049-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
1050-
- For Unicode strings, the default is `VLenUTF8Codec`.
1051-
- For bytes or objects, the default is `VLenBytesCodec`.
1049+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
1050+
- For Unicode strings, the default is ``VLenUTF8Codec``.
1051+
- For bytes or objects, the default is ``VLenBytesCodec``.
10521052
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
10531053
dimension_names : Iterable[str] | None = None
10541054
The names of the dimensions of the array. V3 only.
10551055
chunks : ChunkCoords | None = None
10561056
The shape of the chunks of the array.
1057-
V2 only. V3 arrays should use `chunk_shape` instead.
1057+
V2 only. V3 arrays should use :func:`chunk_shape` instead.
10581058
If not specified, default are guessed based on the shape and dtype.
10591059
dimension_separator : Literal[".", "/"] | None = None
10601060
The delimiter used for the chunk keys. (default: ".")
@@ -1070,9 +1070,9 @@ async def create_array(
10701070
The compressor used to compress the data (default is None).
10711071
V2 only. V3 arrays should use ``codecs`` instead.
10721072
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
1073-
- For numeric arrays, the default is `ZstdCodec`.
1074-
- For Unicode strings, the default is `VLenUTF8Codec`.
1075-
- For bytes or objects, the default is `VLenBytesCodec`.
1073+
- For numeric arrays, the default is ``ZstdCodec``.
1074+
- For Unicode strings, the default is ``VLenUTF8Codec``.
1075+
- For bytes or objects, the default is ``VLenBytesCodec``.
10761076
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
10771077
overwrite : bool = False
10781078
If True, a pre-existing array or group at the path of this array will
@@ -2267,15 +2267,15 @@ def create_array(
22672267
this collection specify the transformation from array values to stored bytes.
22682268
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
22692269
If no codecs are provided, default codecs will be used:
2270-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
2271-
- For Unicode strings, the default is `VLenUTF8Codec`.
2272-
- For bytes or objects, the default is `VLenBytesCodec`.
2270+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
2271+
- For Unicode strings, the default is ``VLenUTF8Codec``.
2272+
- For bytes or objects, the default is ``VLenBytesCodec``.
22732273
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
22742274
dimension_names : Iterable[str] | None = None
22752275
The names of the dimensions of the array. V3 only.
22762276
chunks : ChunkCoords | None = None
22772277
The shape of the chunks of the array.
2278-
V2 only. V3 arrays should use `chunk_shape` instead.
2278+
V2 only. V3 arrays should use :func:`chunk_shape` instead.
22792279
If not specified, default are guessed based on the shape and dtype.
22802280
dimension_separator : Literal[".", "/"] | None = None
22812281
The delimiter used for the chunk keys. (default: ".")
@@ -2291,9 +2291,9 @@ def create_array(
22912291
The compressor used to compress the data (default is None).
22922292
V2 only. V3 arrays should use ``codecs`` instead.
22932293
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
2294-
- For numeric arrays, the default is `ZstdCodec`.
2295-
- For Unicode strings, the default is `VLenUTF8Codec`.
2296-
- For bytes or objects, the default is `VLenBytesCodec`.
2294+
- For numeric arrays, the default is ``ZstdCodec``.
2295+
- For Unicode strings, the default is ``VLenUTF8Codec``.
2296+
- For bytes or objects, the default is ``VLenBytesCodec``.
22972297
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
22982298
overwrite : bool = False
22992299
If True, a pre-existing array or group at the path of this array will
@@ -2631,15 +2631,15 @@ def array(
26312631
this collection specify the transformation from array values to stored bytes.
26322632
V3 only. V2 arrays should use ``filters`` and ``compressor`` instead.
26332633
If no codecs are provided, default codecs will be used:
2634-
- For numeric arrays, the default is `BytesCodec` and `ZstdCodec`.
2635-
- For Unicode strings, the default is `VLenUTF8Codec`.
2636-
- For bytes or objects, the default is `VLenBytesCodec`.
2634+
- For numeric arrays, the default is ``BytesCodec`` and ``ZstdCodec``.
2635+
- For Unicode strings, the default is ``VLenUTF8Codec``.
2636+
- For bytes or objects, the default is ``VLenBytesCodec``.
26372637
These defaults can be changed using the `array.v3_default_codecs` variable in the Zarr config.
26382638
dimension_names : Iterable[str] | None = None
26392639
The names of the dimensions of the array. V3 only.
26402640
chunks : ChunkCoords | None = None
26412641
The shape of the chunks of the array.
2642-
V2 only. V3 arrays should use `chunk_shape` instead.
2642+
V2 only. V3 arrays should use :func:`chunk_shape` instead.
26432643
If not specified, default are guessed based on the shape and dtype.
26442644
dimension_separator : Literal[".", "/"] | None = None
26452645
The delimiter used for the chunk keys. (default: ".")
@@ -2655,9 +2655,9 @@ def array(
26552655
The compressor used to compress the data (default is None).
26562656
V2 only. V3 arrays should use ``codecs`` instead.
26572657
If neither ``compressor`` nor ``filters`` are provided, a default compressor will be used:
2658-
- For numeric arrays, the default is `ZstdCodec`.
2659-
- For Unicode strings, the default is `VLenUTF8Codec`.
2660-
- For bytes or objects, the default is `VLenBytesCodec`.
2658+
- For numeric arrays, the default is ``ZstdCodec``.
2659+
- For Unicode strings, the default is ``VLenUTF8Codec``.
2660+
- For bytes or objects, the default is ``VLenBytesCodec``.
26612661
These defaults can be changed using the `array.v2_default_compressor` variable in the Zarr config.
26622662
overwrite : bool = False
26632663
If True, a pre-existing array or group at the path of this array will

0 commit comments

Comments
 (0)