Skip to content

Commit 68c9c69

Browse files
committed
Add parameter docs to utils.info()
1 parent f7096b0 commit 68c9c69

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

ome_zarr/utils.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,17 @@ def info(path: str, stats: bool = False) -> Iterator[Node]:
2929
3030
All :class:`Nodes <ome_utils.reader.Node>` that are found from the given path will
3131
be visited recursively.
32+
33+
Parameters
34+
----------
35+
path :
36+
Path to OME-Zarr fileset.
37+
stats :
38+
If True, print stats (currently just minimum/maximum of all arrays)
39+
40+
Warnings
41+
--------
42+
Passing ``stats=True`` will trigger a full read of every array in the fileset.
3243
"""
3344
zarr = parse_url(path)
3445
assert zarr, f"not a zarr: {zarr}"

0 commit comments

Comments
 (0)