We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent f7096b0 commit 68c9c69Copy full SHA for 68c9c69
ome_zarr/utils.py
@@ -29,6 +29,17 @@ def info(path: str, stats: bool = False) -> Iterator[Node]:
29
30
All :class:`Nodes <ome_utils.reader.Node>` that are found from the given path will
31
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.
43
"""
44
zarr = parse_url(path)
45
assert zarr, f"not a zarr: {zarr}"
0 commit comments