Skip to content

Commit 1372c82

Browse files
committed
Wait tolerance info
1 parent 82a8760 commit 1372c82

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

scan/commands/wait.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,15 @@ class Wait(Command):
1616
:param value: Desired value.
1717
:param comparison: How current value is compared to the desired value.
1818
Defaults to '='.
19-
Other options: '!=', '>', '>=', '<' , '<=', 'increase by','decrease by'
19+
Other options: '!=', '>', '>=', '<' , '<=', 'increase by','decrease by'.
2020
For string data, supported options are '=', '!=', '>', '>=', '<' , '<='.
2121
:param tolerance: Tolerance used for numeric '=' comparison. Defaults to 0, not used for string values or anything but '='.
2222
:param timeout: Timeout in seconds. Default 0 to wait 'forever'.
2323
:param errhandler: Default None.
24+
25+
For 'increase by' and 'decrease by', the initial value is taken when
26+
the command starts executing, and then it awaits an increment or decrement
27+
of the value from that initial value.
2428
2529
Example:
2630
>>> cmd = Wait('shutter', 1)

0 commit comments

Comments
 (0)