Skip to content

clarify docs for scheduler.run(blocking=False) #129575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clarify docs for scheduler.run(blocking=False) #129575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions Doc/library/sched.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading