]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.14] Clarify docs for scheduler.run(blocking=False) (GH-129575) (GH-150669)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 31 May 2026 12:18:57 +0000 (14:18 +0200)
committerGitHub <noreply@github.com>
Sun, 31 May 2026 12:18:57 +0000 (12:18 +0000)
(cherry picked from commit 2f8f569ba911ab3cff1356a15a3e688adc4ae917)

Co-authored-by: M. Greyson Christoforo <grey@christoforo.net>
Doc/library/sched.rst

index 5560478ce15e28fc04e447c87ae0a9dc50f38e0a..302231d95f89791d8f55e105aadc5567b87edb68 100644 (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