Skip to content

Commit aef04d6

Browse files
maxrjonesmaxrjones
committed
Fix docstring failures
1 parent 85b369d commit aef04d6

File tree

3 files changed

+23
-22
lines changed

3 files changed

+23
-22
lines changed

‎src/zarr/api/asynchronous.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -352,8 +352,8 @@ async def open(
352352
If using an fsspec URL to create the store, these will be passed to
353353
the backend implementation. Ignored otherwise.
354354
**kwargs
355-
Additional parameters are passed through to [zarr.creation.open_array][] or
356-
[zarr.api.asynchronous.open_group][].
355+
Additional parameters are passed through to [`zarr.creation.open_array`][] or
356+
[`open_group`][zarr.api.asynchronous.open_group].
357357
358358
Returns
359359
-------
@@ -1105,7 +1105,7 @@ async def empty(
11051105
shape : int or tuple of int
11061106
Shape of the empty array.
11071107
**kwargs
1108-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1108+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
11091109
11101110
Notes
11111111
-----
@@ -1127,7 +1127,7 @@ async def empty_like(
11271127
a : array-like
11281128
The array to create an empty array like.
11291129
**kwargs
1130-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1130+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
11311131
11321132
Returns
11331133
-------
@@ -1160,7 +1160,7 @@ async def full(
11601160
fill_value : scalar
11611161
Fill value.
11621162
**kwargs
1163-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1163+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
11641164
11651165
Returns
11661166
-------
@@ -1181,7 +1181,7 @@ async def full_like(
11811181
a : array-like
11821182
The array to create an empty array like.
11831183
**kwargs
1184-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1184+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
11851185
11861186
Returns
11871187
-------
@@ -1205,7 +1205,7 @@ async def ones(
12051205
shape : int or tuple of int
12061206
Shape of the empty array.
12071207
**kwargs
1208-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1208+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
12091209
12101210
Returns
12111211
-------
@@ -1225,7 +1225,7 @@ async def ones_like(
12251225
a : array-like
12261226
The array to create an empty array like.
12271227
**kwargs
1228-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1228+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
12291229
12301230
Returns
12311231
-------
@@ -1329,7 +1329,7 @@ async def zeros(
13291329
shape : int or tuple of int
13301330
Shape of the empty array.
13311331
**kwargs
1332-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1332+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
13331333
13341334
Returns
13351335
-------
@@ -1349,7 +1349,7 @@ async def zeros_like(
13491349
a : array-like
13501350
The array to create an empty array like.
13511351
**kwargs
1352-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1352+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
13531353
13541354
Returns
13551355
-------

‎src/zarr/api/synchronous.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ def open(
199199
the backend implementation. Ignored otherwise.
200200
**kwargs
201201
Additional parameters are passed through to [`zarr.creation.open_array`][] or
202-
[`zarr.api.synchronous.open_group`][].
202+
[`open_group`][zarr.api.asynchronous.open_group].
203203
204204
Returns
205205
-------
@@ -291,7 +291,7 @@ def save_array(
291291
If using an fsspec URL to create the store, these will be passed to
292292
the backend implementation. Ignored otherwise.
293293
**kwargs
294-
Passed through to [`create`][zarr.api.synchronous.create], e.g., compressor.
294+
Passed through to [`create`][zarr.api.asynchronous.create], e.g., compressor.
295295
"""
296296
return sync(
297297
async_api.save_array(
@@ -383,7 +383,7 @@ def array(data: npt.ArrayLike | Array, **kwargs: Any) -> Array:
383383
data : array_like
384384
The data to fill the array with.
385385
**kwargs
386-
Passed through to [`create`][zarr.api.synchronous.create].
386+
Passed through to [`create`][zarr.api.asynchronous.create].
387387
388388
Returns
389389
-------
@@ -1196,7 +1196,7 @@ def empty(shape: tuple[int, ...], **kwargs: Any) -> Array:
11961196
shape : int or tuple of int
11971197
Shape of the empty array.
11981198
**kwargs
1199-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1199+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
12001200
12011201
Returns
12021202
-------
@@ -1223,7 +1223,7 @@ def empty_like(a: ArrayLike, **kwargs: Any) -> Array:
12231223
a : array-like
12241224
The array to create an empty array like.
12251225
**kwargs
1226-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1226+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
12271227
12281228
Returns
12291229
-------
@@ -1250,7 +1250,7 @@ def full(shape: tuple[int, ...], fill_value: Any, **kwargs: Any) -> Array:
12501250
fill_value : scalar
12511251
Fill value.
12521252
**kwargs
1253-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1253+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
12541254
12551255
Returns
12561256
-------
@@ -1270,7 +1270,7 @@ def full_like(a: ArrayLike, **kwargs: Any) -> Array:
12701270
a : array-like
12711271
The array to create an empty array like.
12721272
**kwargs
1273-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1273+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
12741274
12751275
Returns
12761276
-------
@@ -1289,7 +1289,7 @@ def ones(shape: tuple[int, ...], **kwargs: Any) -> Array:
12891289
shape : int or tuple of int
12901290
Shape of the empty array.
12911291
**kwargs
1292-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1292+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
12931293
12941294
Returns
12951295
-------
@@ -1308,7 +1308,7 @@ def ones_like(a: ArrayLike, **kwargs: Any) -> Array:
13081308
a : array-like
13091309
The array to create an empty array like.
13101310
**kwargs
1311-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1311+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
13121312
13131313
Returns
13141314
-------
@@ -1344,7 +1344,7 @@ def open_array(
13441344
If using an fsspec URL to create the store, these will be passed to
13451345
the backend implementation. Ignored otherwise.
13461346
**kwargs
1347-
Any keyword arguments to pass to [zarr.api.synchronous.create][].
1347+
Any keyword arguments to pass to [`create`][zarr.api.asynchronous.create].
13481348
13491349
13501350
Returns
@@ -1396,7 +1396,7 @@ def zeros(shape: tuple[int, ...], **kwargs: Any) -> Array:
13961396
shape : int or tuple of int
13971397
Shape of the empty array.
13981398
**kwargs
1399-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1399+
Keyword arguments passed to [`zarr.api.asynchronous.create`][].
14001400
14011401
Returns
14021402
-------
@@ -1415,7 +1415,7 @@ def zeros_like(a: ArrayLike, **kwargs: Any) -> Array:
14151415
a : array-like
14161416
The array to create an empty array like.
14171417
**kwargs
1418-
Keyword arguments passed to [zarr.api.asynchronous.create][].
1418+
Keyword arguments passed to [`create`][zarr.api.asynchronous.create].
14191419
14201420
Returns
14211421
-------

‎src/zarr/core/array.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4756,6 +4756,7 @@ async def create_array(
47564756
chunk to bytes.
47574757
47584758
For Zarr format 3, a "filter" is a codec that takes an array and returns an array,
4759+
47594760
and these values must be instances of [`zarr.abc.codec.ArrayArrayCodec`][], or a
47604761
dict representations of [`zarr.abc.codec.ArrayArrayCodec`][].
47614762

0 commit comments

Comments
 (0)