[3.13] Clarify docs for scheduler.run(blocking=False) (GH-129575) (GH-150670)

(cherry picked from commit 2f8f569ba9)

Co-authored-by: M. Greyson Christoforo <grey@christoforo.net>
This commit is contained in:
Miss Islington (bot) 2026-05-31 14:18:09 +02:00 committed by GitHub
parent e10a8ba821
commit ca2fdca948
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -119,9 +119,11 @@ Scheduler Objects
function passed to the constructor) for the next event, then execute it and so
on until there are no more scheduled events.
If *blocking* is false executes the scheduled events due to expire soonest
(if any) and then return the deadline of the next scheduled call in the
scheduler (if any).
If *blocking* is false, immediately executes all events in the queue which have
a time value less than or equal to the current *timefunc* value (if any) and
returns the difference between the current *timefunc* value and the time value
of the next scheduled event in the scheduler's event queue. If the queue is
empty, returns ``None``.
Either *action* or *delayfunc* can raise an exception. In either case, the
scheduler will maintain a consistent state and propagate the exception. If an