Fixed documentation.

displayarray/frame/frame_updater.py

@@ -132,14 +132,14 @@ class FrameUpdater(threading.Thread):
     """
     Read back all updates from the requested videos.
 
-    Example usage:
+    Examp#le usage:
 
-    .. code-block:: python
+    .. co#de-block:: python
 
-      >>> from examples.videos import test_video
+      >>#> from examples.videos import test_video
-      >>> f = 0
+      >>#> f = 0
-      >>> for f, r in enumerate(read_updates(test_video, end_callback=lambda :f==2)):
+      >>#> for f, r in enumerate(read_updates(test_video, end_callback=lambda :f==2)):
-      ...   print(f"Frame:{f}. Array:{r}")
+      ..#.   print(f"Frame:{f}. Array:{r}")
 
     """
     from displayarray.window import SubscriberWindows

displayarray/window/subscriber_windows.py

@@ -349,4 +349,5 @@ def breakpoint_display(*args, **kwargs):
 
 
 def read_updates(*args, **kwargs):
+    """Read back all frame updates and yield a list of frames. List is empty if no frames were read."""
     return display(*args, **kwargs, silent=True)

docs/docsrc/display.rst

@@ -4,6 +4,7 @@ displayarray.display
 
 .. autofunction:: display
 .. autofunction:: breakpoint_display
+.. autofunction:: read_updates
 
 Windows
 -------

docs/docsrc/frame.rst

@@ -1,12 +1,6 @@
 displayarray.frame
 ===================================
 
-Read Updates
-------------
-.. currentmodule:: displayarray
-
-.. autofunction:: read_updates
-
 Frame Passing
 -------------
 .. currentmodule:: displayarray.frame