From 8a1864d8ca5d4e7dd2f02bb234743b9d16078437 Mon Sep 17 00:00:00 2001
From: Henry Pinkard <7969470+henrypinkard@users.noreply.github.com>
Date: Mon, 26 Aug 2024 10:53:24 -0400
Subject: [PATCH 1/2] improve docstring

---
 src/exengine/events/detector_events.py | 22 ++++++++++++++--------
 1 file changed, 14 insertions(+), 8 deletions(-)

diff --git a/src/exengine/events/detector_events.py b/src/exengine/events/detector_events.py
index fc040d6..91d1388 100644
--- a/src/exengine/events/detector_events.py
+++ b/src/exengine/events/detector_events.py
@@ -19,17 +19,23 @@ class ReadoutData(Stoppable, DataProducing, ExecutorEvent):
     """
     Readout one or more blocks of data (e.g. images) and associated metadata from a Detector device (e.g. a camera)
 
-    :param data_coordinate_iterator (Iterable[DataCoordinates]): An iterator or list of DataCoordinates objects, which
-                specify the coordinates of the data that will be read out, should be able to provide at least num_images
-                elements (or indefinitely if num_images is None)
-    :param detector (Union[Detector, str]): The Detector object to read data from. Can be the object itself,
+    Parameters:
+    ------------
+    data_coordinate_iterator: Iterable[DataCoordinates]
+            An iterator or list of DataCoordinates objects, which
+            specify the coordinates of the data that will be read out, should be able to provide at least num_images
+            elements (or indefinitely if num_images is None)
+    detector: Union[Detector, str]
+            The Detector object to read data from. Can be the object itself,
             or the name of the object in the ExecutionEngine's device registry.
-    :param num_blocks (int): The number of pieces of data (e.g. images) to read out. If None, the readout will continue until
+    num_blocks: int
+            The number of pieces of data (e.g. images) to read out. If None, the readout will continue until
             the data_coordinate_iterator is exhausted or the Detector is stopped and no more images are available.
-    :param stop_on_empty (bool): If True, the readout will stop when the detector is stopped when there is no data
+    stop_on_empty: bool
+            (Experimental) If True, the readout will stop when the detector is stopped when there is no data
             available to read
-    :param data_handler (DataHandler): The DataHandler object that will handle the data read out by this event
-
+    data_handler: DataHandler
+            The DataHandler object that will handle the data read out by this event
     """
     notification_types = [DataAcquiredNotification]
 

From 7a1e7a5955a636466eee959129bed1946eadbd18 Mon Sep 17 00:00:00 2001
From: Henry Pinkard <7969470+henrypinkard@users.noreply.github.com>
Date: Tue, 27 Aug 2024 09:22:39 -0400
Subject: [PATCH 2/2] clean up figure

---
 docs/_static/exengine_bigpicture.svg | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/_static/exengine_bigpicture.svg b/docs/_static/exengine_bigpicture.svg
index 1efb8d6..5c01a53 100644
--- a/docs/_static/exengine_bigpicture.svg
+++ b/docs/_static/exengine_bigpicture.svg
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:719799206d70f54ae412138691cafc347b5d659c4a6af9c963857e122793fc9b
-size 10335093
+oid sha256:c0f5ec49dcb40c9217e86b823af2aa92c3d9c7e4634f37efac1f363cfb241fed
+size 7067358