From c68c3c1b54ecff2c51417168ee3e91b4056831fc Mon Sep 17 00:00:00 2001 From: wakonig_k Date: Fri, 8 Mar 2024 17:13:15 +0100 Subject: [PATCH] docs: improved doc strings for computed signal --- ophyd_devices/utils/dynamic_pseudo.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/ophyd_devices/utils/dynamic_pseudo.py b/ophyd_devices/utils/dynamic_pseudo.py index 1dc8839..d4157d0 100644 --- a/ophyd_devices/utils/dynamic_pseudo.py +++ b/ophyd_devices/utils/dynamic_pseudo.py @@ -73,6 +73,9 @@ class ComputedSignal(SignalRO): representation of a function that takes the input signals as arguments and returns the computed value. + Example: + >>> signal.compute_method = "def test(a, b): return a.get() + b.get()" + """ return self._compute_method @@ -95,6 +98,9 @@ class ComputedSignal(SignalRO): Args: *input_vars: The input signals to be used for the computation + Example: + >>> signal.input_signals = ["samx_readback", "samx_readback"] + """ return self._input_signals