Skip to content

Commit e22b2f4

Browse files
committed
DOC: Improve Viewers.data return description
1 parent 3c7b60b commit e22b2f4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

itkwidgets/cell_watcher.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ def __init__(self):
2323
def data(self) -> Dict[str, Dict[str, bool]]:
2424
"""Get the underlying data dict containg all viewer data
2525
26-
:return: The data object that contains all created Viewer information.
26+
:return: A dict of key, value pairs mapping the unique Viewer name to a
27+
dictionary containing a 'ready' key and a boolean value reflecting the
28+
ready state of the Viewer.
2729
:rtype: Dict[str, Dict[str, bool]]
2830
"""
2931
return self._data

0 commit comments

Comments
 (0)