Skip to content

Commit f083a93

Browse files
committed
Merge branch 'docs/add-docstrings' of github.com:zarr-developers/zarr-python into docs/add-docstrings
2 parents b9bb728 + 4a0a97c commit f083a93

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

src/zarr/api/synchronous.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ def consolidate_metadata(
7878
7979
Returns
8080
-------
81-
group: AsyncGroup
81+
group: Group
8282
The group, with the ``consolidated_metadata`` field set to include
8383
the metadata of each child node.
8484
"""
@@ -163,8 +163,8 @@ def open(
163163
If using an fsspec URL to create the store, these will be passed to
164164
the backend implementation. Ignored otherwise.
165165
**kwargs
166-
Additional parameters are passed through to :func:`zarr.creation.open_array` or
167-
:func:`zarr.hierarchy.open_group`.
166+
Additional parameters are passed through to :func:`zarr.api.asynchronous.open_array` or
167+
:func:`zarr.api.asynchronous.open_group`.
168168
169169
Returns
170170
-------
@@ -350,7 +350,7 @@ def array(data: npt.ArrayLike, **kwargs: Any) -> Array:
350350
351351
Returns
352352
-------
353-
array : array
353+
array : Array
354354
The new array.
355355
"""
356356

@@ -403,7 +403,7 @@ def group(
403403
404404
Returns
405405
-------
406-
g : group
406+
g : Group
407407
The new group.
408408
"""
409409
return Group(
@@ -499,7 +499,7 @@ def open_group(
499499
500500
Returns
501501
-------
502-
g : group
502+
g : Group
503503
The new group.
504504
"""
505505
return Group(
@@ -636,7 +636,7 @@ def create(
636636
637637
Returns
638638
-------
639-
z : array
639+
z : Array
640640
The array.
641641
"""
642642
return Array(
@@ -685,6 +685,11 @@ def empty(shape: ChunkCoords, **kwargs: Any) -> Array:
685685
Shape of the empty array.
686686
**kwargs
687687
Keyword arguments passed to :func:`zarr.api.asynchronous.create`.
688+
689+
Returns
690+
-------
691+
Array
692+
The new array.
688693
689694
Notes
690695
-----

0 commit comments

Comments
 (0)