Skip to content

Commit 5525d74

Browse files
committed
doc tweak
1 parent 1525e6b commit 5525d74

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

appdaemon/adapi.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3241,8 +3241,8 @@ async def run_every(
32413241
intervals will be calculated forward from the start time, and the first trigger will be the first
32423242
interval in the future.
32433243
3244-
- If this is ``now`` (default), then the first run will be now + interval
3245-
- If this is ``immediate``, then the callback will be run immediately
3244+
- If this is ``now`` (default), then the first trigger will be now + interval
3245+
- If this is ``immediate``, then the first trigger will happen immediately
32463246
- Other ``str`` types will be parsed with :meth:`~appdaemon.adapi.ADAPI.parse_time()`.
32473247
- If this is a ``datetime.time`` object, the current date will be assumed.
32483248
- If this is a ``datetime.datetime`` object, it will be used as is.

docs/HISTORY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
- Reload modified apps on SIGUSR2 - contributed by [chatziko](https://github.com/chatziko)
1010
- Using urlib to create endpoints from URLs - contributed by [cebtenzzre](https://github.com/cebtenzzre)
1111
- Added {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.process_conversation` and {py:meth}`~appdaemon.plugins.hass.hassapi.Hass.reload_conversation` to the {ref}`Hass API <hass-api-usage>`.
12-
- Added `immediate` kwargs to `run_every` to control semantics around `start == "now"`
12+
- Added special value `immediate` to {py:meth}`~appdaemon.adapi.ADAPI.run_every` semantics for the `start` kwarg. See the method docs for more information.
1313

1414
**Fixes**
1515

0 commit comments

Comments
 (0)