summaryrefslogtreecommitdiff
path: root/Lib/sched.py
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2012-12-29 20:59:29 +0200
committerSerhiy Storchaka <storchaka@gmail.com>2012-12-29 20:59:29 +0200
commitd1ced9e86a4652366e574a880636c7bd804f5475 (patch)
tree4515afd274f229c424403a4933468a0d98679c97 /Lib/sched.py
parent49f7e58778733dbb86dad145dd35f906fd5bafbb (diff)
parente912496c6025581f8f1554c9cda92ae73f2514e5 (diff)
downloadcpython-git-d1ced9e86a4652366e574a880636c7bd804f5475.tar.gz
Issue #16642: Document kwargs field in sched.Event named tuple.
Diffstat (limited to 'Lib/sched.py')
-rw-r--r--Lib/sched.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/Lib/sched.py b/Lib/sched.py
index 5551f71df6..e523bc1c0d 100644
--- a/Lib/sched.py
+++ b/Lib/sched.py
@@ -13,12 +13,12 @@ also be used to integrate scheduling with STDWIN events; the delay
function is allowed to modify the queue. Time can be expressed as
integers or floating point numbers, as long as it is consistent.
-Events are specified by tuples (time, priority, action, argument).
+Events are specified by tuples (time, priority, action, argument, kwargs).
As in UNIX, lower priority numbers mean higher priority; in this
way the queue can be maintained as a priority queue. Execution of the
event means calling the action function, passing it the argument
sequence in "argument" (remember that in Python, multiple function
-arguments are be packed in a sequence).
+arguments are be packed in a sequence) and keyword parameters in "kwargs".
The action function may be an instance method so it
has another way to reference private data (besides global variables).
"""
@@ -151,7 +151,7 @@ class scheduler:
"""An ordered list of upcoming events.
Events are named tuples with fields for:
- time, priority, action, arguments
+ time, priority, action, arguments, kwargs
"""
# Use heapq to sort the queue rather than using 'sorted(self._queue)'.