summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMariatta <Mariatta@users.noreply.github.com>2017-11-25 05:43:01 (GMT)
committerGitHub <noreply@github.com>2017-11-25 05:43:01 (GMT)
commit9d5ec808de2c1359f434cc2fa8378458e4339c96 (patch)
tree485ac0bc669f0e817208d6834d65a4324844dc32
parent610e5afdcbe3eca906ef32f4e0364e20e1b1ad23 (diff)
downloadcpython-9d5ec808de2c1359f434cc2fa8378458e4339c96.zip
cpython-9d5ec808de2c1359f434cc2fa8378458e4339c96.tar.gz
cpython-9d5ec808de2c1359f434cc2fa8378458e4339c96.tar.bz2
Improve Scheduler Objects documentation. (GH-4556)
Mention that the lower the priority number, the higher priority it represents.
-rw-r--r--Doc/library/sched.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/library/sched.rst b/Doc/library/sched.rst
index 4d4a616..6094a7b 100644
--- a/Doc/library/sched.rst
+++ b/Doc/library/sched.rst
@@ -69,7 +69,7 @@ Scheduler Objects
Schedule a new event. The *time* argument should be a numeric type compatible
with the return value of the *timefunc* function passed to the constructor.
Events scheduled for the same *time* will be executed in the order of their
- *priority*.
+ *priority*. A lower number represents a higher priority.
Executing the event means executing ``action(*argument, **kwargs)``.
*argument* is a sequence holding the positional arguments for *action*.