DOC: Improve Viewers.data return description

InsightSoftwareConsortium · Dec 19, 2023 · e22b2f4 · e22b2f4
1 parent 3c7b60b
commit e22b2f4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/itkwidgets/cell_watcher.py b/itkwidgets/cell_watcher.py
@@ -23,7 +23,9 @@ def __init__(self):
     def data(self) -> Dict[str, Dict[str, bool]]:
         """Get the underlying data dict containg all viewer data
 
-        :return: The data object that contains all created Viewer information.
+        :return: A dict of key, value pairs mapping the unique Viewer name to a
+        dictionary containing a 'ready' key and a boolean value reflecting the
+        ready state of the Viewer.
         :rtype:  Dict[str, Dict[str, bool]]
         """
         return self._data