Add possible values to timer missed_tick_policy parameter documentation

Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
frequenz-floss · May 24, 2023 · ae6a8ae · ae6a8ae
1 parent 68b6610
commit ae6a8ae
Showing 1 changed file with 4 additions and 3 deletions.
diff --git 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