From ae6a8ae7459ed767391bbc3b4fe7d529cb04c0c3 Mon Sep 17 00:00:00 2001 From: "Mathias L. Baumann" Date: Wed, 24 May 2023 18:21:45 +0200 Subject: [PATCH] Add possible values to timer missed_tick_policy parameter documentation Signed-off-by: Mathias L. Baumann --- src/frequenz/channels/util/_timer.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/frequenz/channels/util/_timer.py b/src/frequenz/channels/util/_timer.py index 7742042f..d49a3664 100644 --- a/src/frequenz/channels/util/_timer.py +++ b/src/frequenz/channels/util/_timer.py @@ -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