From 0033f48f3b1177a06b4a332a3c1aa0979b94f6ee Mon Sep 17 00:00:00 2001 From: Jakub Wlodek Date: Fri, 22 Mar 2024 10:11:50 -0400 Subject: [PATCH] Update docstring for ADTriggerStatus --- ophyd/areadetector/trigger_mixins.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/ophyd/areadetector/trigger_mixins.py b/ophyd/areadetector/trigger_mixins.py index 36ab8b2fb..8138eb0b1 100644 --- a/ophyd/areadetector/trigger_mixins.py +++ b/ophyd/areadetector/trigger_mixins.py @@ -24,7 +24,12 @@ class ADTriggerStatus(DeviceStatus): A Status for AreaDetector triggers A special status object that notifies watches (progress bars) - based on comparing device.cam.array_counter to device.cam.num_images. + based on comparing the two signal values counter_signal and + target_signal passed to the object instance at __init__. Once the + value of counter_signal reaches target_signal, the operation is considered done. + If these two signals are passed in as None or not passed in at all (default), + then the standard device.cam.array_counter signal is used as the + progress indicator, and device.cam.num_images is used as the target. """ def __init__(self, *args, counter_signal = None, target_signal = None, **kwargs):