Skip to content

Improve Scheduler Objects documentation. #4556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mariatta merged 2 commits into from
Nov 25, 2017
Merged

Improve Scheduler Objects documentation. #4556

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4575240
Improve Scheduler Objects documentation.
Mariatta Nov 25, 2017
8fd3979
Add an 'A'.
Mariatta Nov 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/library/sched.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

@serhiy-storchaka serhiy-storchaka Nov 25, 2017

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the former wording was unclear, wouldn't be better to add just a word "increasing": executed in the order of increasing their *priority*. "Lower is higher" looks slightly orwellish to me.

@boscorona boscorona Dec 11, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@serhiy-storchaka So we should invert the meaning?


Executing the event means executing ``action(*argument, **kwargs)``.
*argument* is a sequence holding the positional arguments for *action*.
Expand Down