File tree Expand file tree Collapse file tree 1 file changed +4
-5
lines changed Expand file tree Collapse file tree 1 file changed +4
-5
lines changed Original file line number Diff line number Diff line change @@ -970,11 +970,10 @@ It takes the following keyword arguments (all are optional):
970
970
before a subsequent state trigger occurs. The default value of ``None `` means that the trigger can
971
971
occur without the trigger expression having to be ``False ``. A value of ``0 `` requires the
972
972
expression become ``False `` before the trigger, but with no minimum time in that state.
973
- With the default of ``state_check_now=True ``, the state trigger expression is checked at startup,
974
- and if ``True `` the trigger will not occur, and a wait for the next ``False `` will begin.
975
- If ``state_check_now==False ``, the ``state_hold_false `` period applies at startup, although the
976
- expression is not checked at startup. So if ``state_hold_false=0 `` the first trigger after startup
977
- will succeed, whether or not the expression was previously ``False ``.
973
+ When ``state_hold_false `` is set, the state trigger expression is evaluated immediately. If ``False ``
974
+ the ``state_hold_false `` period begins. If ``True ``, a wait for the next ``False `` value begins.
975
+ If ``state_check_now `` is also set, ``task.wait_until() `` will still return immediately if the
976
+ expression is initially ``True ``.
978
977
979
978
When a trigger occurs, the return value is a ``dict `` containing the same keyword values that are
980
979
passed into the function when the corresponding decorator trigger occurs. There will always be a key
You can’t perform that action at this time.
0 commit comments