Skip to content

Commit 8ef98ca

Browse files
committed
Rework Node.add documentation
1 parent bdf0686 commit 8ef98ca

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

ome_zarr/reader.py

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,17 @@ def add(
8989
) -> "Optional[Node]":
9090
"""Create a child node if this location has not yet been seen.
9191
92-
Returns None if the node has already been processed.
93-
94-
By setting prepend, the addition will be considered as higher priority
95-
node which will likely be turned into a lower layer for display.
96-
97-
By unsetting visible, the node (and in turn the layer) can be
98-
deactivated for initial display. By default, the value of the current
99-
node will be propagated.
92+
Newly created nodes may be considered higher or lower priority than
93+
the current node, and may be set to invisible if necessary.
94+
95+
:param zarr: Location in the node hierarchy to be added
96+
:param prepend: Whether the newly created node should be given higher
97+
priority than the current node, defaults to False
98+
:param visibility: Allows setting the node (and therefore layer)
99+
as deactivated for initial display or if None the value of the
100+
current node will be propagated to the new node, defaults to None
101+
:return: Newly created node if this is the first time it has been
102+
encountered; None if the node has already been processed.
100103
"""
101104

102105
if zarr.zarr_path in self.seen:

0 commit comments

Comments
 (0)