Schedule: Improve doc, code comments.

peterhinch · peterhinch · commit 024b0802dcbd · 2023-11-24T10:56:24.000Z
diff --git a/v3/as_drivers/sched/sched.py b/v3/as_drivers/sched/sched.py
@@ -11,7 +11,8 @@
 
 # uasyncio can't handle long delays so split into 1000s (1e6 ms) segments
 _MAXT = const(1000)
-# Wait prior to a sequence start
+# Wait prior to a sequence start: see
+# https://github.com/peterhinch/micropython-async/blob/master/v3/docs/SCHEDULE.md#71-initialisation
 _PAUSE = const(2)
 
 
diff --git a/v3/docs/SCHEDULE.md b/v3/docs/SCHEDULE.md
@@ -115,7 +115,9 @@ asyncio.create_task(schedule(foo, 'every 4 mins', hrs=None, mins=range(0, 60, 4)
 Positional args:
  1. `func` This may be a callable (callback or coroutine) to run, a user defined
  `Event` or an instance of a `Sequence`.
- 2. Any further positional args are passed to the callable or the `Sequence`.
+ 2. Any further positional args are passed to the callable or the `Sequence`;
+ these args can be used to enable the triggered object to determine the source
+ of the trigger.
 
 Keyword-only args. Args 1..6 are
 [Time specifiers](./SCHEDULE.md#41-time-specifiers): a variety of data types
@@ -168,6 +170,9 @@ try:
 finally:
     _ = asyncio.new_event_loop()
 ```
+Note that the asynchronous iterator produces a `tuple` of the args passed to the
+`schedule` that triggered it. This enables the code to determine the source of
+the trigger.
 
 ##### [Top](./SCHEDULE.md#0-contents)
 
