Skip to content
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

Add possible values to timer missed_tick_policy parameter documentation #109

Merged
merged 1 commit into from
May 25, 2023
Merged

Add possible values to timer missed_tick_policy parameter documentation #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions src/frequenz/channels/util/_timer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,9 +365,10 @@ def __init__(
Args:
interval: The time between timer ticks. Must be at least
1 microsecond.
missed_tick_policy: The policy of the timer when it misses
a tick. See the documentation of `MissedTickPolicy` for
details.
missed_tick_policy: The policy of the timer when it misses a tick.
Commonly one of `TriggerAllMissed`, `SkipMissedAndResync`, `SkipMissedAndDrift`
or a custom class deriving from `MissedTickPolicy`. See the
documentation of the each class for more details.
auto_start: Whether the timer should be started when the
instance is created. This can only be `True` if there is
already a running loop or an explicit `loop` that is running
Expand Down