mirror of
https://github.com/bec-project/ophyd_devices.git
synced 2025-07-07 09:44:47 +02:00
docs: improved doc strings for computed signal
This commit is contained in:
@ -73,6 +73,9 @@ class ComputedSignal(SignalRO):
|
|||||||
representation of a function that takes the input signals as arguments
|
representation of a function that takes the input signals as arguments
|
||||||
and returns the computed value.
|
and returns the computed value.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
>>> signal.compute_method = "def test(a, b): return a.get() + b.get()"
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self._compute_method
|
return self._compute_method
|
||||||
|
|
||||||
@ -95,6 +98,9 @@ class ComputedSignal(SignalRO):
|
|||||||
Args:
|
Args:
|
||||||
*input_vars: The input signals to be used for the computation
|
*input_vars: The input signals to be used for the computation
|
||||||
|
|
||||||
|
Example:
|
||||||
|
>>> signal.input_signals = ["samx_readback", "samx_readback"]
|
||||||
|
|
||||||
"""
|
"""
|
||||||
return self._input_signals
|
return self._input_signals
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user