Improve Scheduler Objects documentation. (GH-4556)

Mention that the lower the priority number, the higher priority it represents.
This commit is contained in:
Mariatta 2017-11-24 21:43:01 -08:00 committed by GitHub
parent 610e5afdcb
commit 9d5ec808de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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*.