summaryrefslogtreecommitdiffstats
path: root/Doc/library/sched.rst
diff options
context:
space:
mode:
authorGiampaolo Rodola' <g.rodola@gmail.com>2012-03-15 12:05:41 (GMT)
committerGiampaolo Rodola' <g.rodola@gmail.com>2012-03-15 12:05:41 (GMT)
commita4e018889ac3537e10b48811b4be6356e633b8a0 (patch)
treeef43ce4ff4f5bd657b7dd17e234bb1a388c7e69b /Doc/library/sched.rst
parent17160fd6d6d7850294a9a465a3e5e399e5028bb6 (diff)
downloadcpython-a4e018889ac3537e10b48811b4be6356e633b8a0.zip
cpython-a4e018889ac3537e10b48811b4be6356e633b8a0.tar.gz
cpython-a4e018889ac3537e10b48811b4be6356e633b8a0.tar.bz2
(sched) when run() is invoked with blocking=False return the deadline of the next scheduled call in the scheduler; this use case was suggested in http://bugs.python.org/issue1641#msg149453
Diffstat (limited to 'Doc/library/sched.rst')
-rw-r--r--Doc/library/sched.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/sched.rst b/Doc/library/sched.rst
index 957bdd3..d6c86c7 100644
--- a/Doc/library/sched.rst
+++ b/Doc/library/sched.rst
@@ -109,7 +109,8 @@ Scheduler Objects
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.
+ (if any) and then return the deadline of the next scheduled call in the
+ scheduler (if any).
Either *action* or *delayfunc* can raise an exception. In either case, the
scheduler will maintain a consistent state and propagate the exception. If an