[Python-checkins] Improve Scheduler Objects documentation. (GH-4556) (GH-4557)
Mariatta
webhook-mailer at python.org
Sat Nov 25 00:48:28 EST 2017
https://github.com/python/cpython/commit/db897b196163a2930dcbf2f516f5549b09ba7998
commit: db897b196163a2930dcbf2f516f5549b09ba7998
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017-11-24T21:48:26-08:00
summary:
Improve Scheduler Objects documentation. (GH-4556) (GH-4557)
Mention that the lower the priority number, the higher priority it represents.
(cherry picked from commit 9d5ec808de2c1359f434cc2fa8378458e4339c96)
files:
M Doc/library/sched.rst
diff --git a/Doc/library/sched.rst b/Doc/library/sched.rst
index 4d4a6161057..6094a7b8714 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*.
More information about the Python-checkins
mailing list