Remove Timer.periodic() and Timer.timeout() from docs

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

README.md

@@ -110,7 +110,7 @@ from frequenz.channels import (
     select,
     selected_from,
 )
-from frequenz.channels.timer import Timer
+from frequenz.channels.timer import SkipMissedAndDrift, Timer, TriggerAllMissed
 
 
 class Command(Enum):
@@ -135,7 +135,7 @@ async def send(
 ) -> None:
     """Send a counter value every second, until a stop command is received."""
     print(f"{sender}: Starting")
-    timer = Timer.periodic(timedelta(seconds=1.0))
+    timer = Timer(timedelta(seconds=1.0), TriggerAllMissed())
     counter = 0
     async for selected in select(timer, control_command):
         if selected_from(selected, timer):
@@ -163,7 +163,7 @@ async def receive(
 ) -> None:
     """Receive data from multiple channels, until no more data is received for 2 seconds."""
     print("receive: Starting")
-    timer = Timer.timeout(timedelta(seconds=2.0))
+    timer = Timer(timedelta(seconds=2.0), SkipMissedAndDrift())
     print(f"{timer=}")
     merged = merge(*receivers)
     async for selected in select(merged, timer, control_command):

docs/user-guide/utilities/timers.md

@@ -55,47 +55,6 @@
         show_root_toc_entry: false
         show_source: false
 
-### Periodic Timers
-
-::: frequenz.channels.timer.Timer.periodic
-    options:
-        inherited_members: []
-        members: []
-        show_bases: false
-        show_root_heading: false
-        show_root_toc_entry: false
-        show_source: false
-        show_docstring_attributes: false
-        show_docstring_functions: false
-        show_docstring_classes: false
-        show_docstring_other_parameters: false
-        show_docstring_parameters: false
-        show_docstring_raises: false
-        show_docstring_receives: false
-        show_docstring_returns: false
-        show_docstring_warns: false
-        show_docstring_yields: false
-
-### Timeouts
-
-::: frequenz.channels.timer.Timer.timeout
-    options:
-        inherited_members: []
-        members: []
-        show_bases: false
-        show_root_heading: false
-        show_root_toc_entry: false
-        show_source: false
-        show_docstring_attributes: false
-        show_docstring_functions: false
-        show_docstring_classes: false
-        show_docstring_other_parameters: false
-        show_docstring_parameters: false
-        show_docstring_raises: false
-        show_docstring_receives: false
-        show_docstring_returns: false
-        show_docstring_warns: false
-        show_docstring_yields: false
 
 ## Low-level Interface
 

src/frequenz/channels/_select.py

@@ -400,10 +400,10 @@ async def select(*receivers: Receiver[Any]) -> AsyncIterator[Selected[Any]]:
         from typing import assert_never
 
         from frequenz.channels import ReceiverStoppedError, select, selected_from
-        from frequenz.channels.timer import Timer
+        from frequenz.channels.timer import SkipMissedAndDrift, Timer, TriggerAllMissed
 
-        timer1 = Timer.periodic(datetime.timedelta(seconds=1))
-        timer2 = Timer.timeout(datetime.timedelta(seconds=0.5))
+        timer1 = Timer(datetime.timedelta(seconds=1), TriggerAllMissed())
+        timer2 = Timer(datetime.timedelta(seconds=0.5), SkipMissedAndDrift())
 
         async for selected in select(timer1, timer2):
             if selected_from(selected, timer1):

src/frequenz/channels/timer.py

@@ -6,8 +6,8 @@
 # Quick Start
 
 If you need to do something as periodically as possible (avoiding
-[drifts](#missed-ticks-and-drifting)), you can use use
-a [`periodic()`][frequenz.channels.timer.Timer.periodic] timer.
+[drifts](#missed-ticks-and-drifting)), you can use
+a [`Timer`][frequenz.channels.timer.Timer] like this:
 
 Example: Periodic Timer
     ```python
@@ -18,16 +18,16 @@
 
 
     async def main() -> None:
-        async for drift in Timer.periodic(timedelta(seconds=1.0)):
+        async for drift in Timer(timedelta(seconds=1.0), TriggerAllMissed()):
             print(f"The timer has triggered at {datetime.now()} with a drift of {drift}")
 
 
     asyncio.run(main())
     ```
 
 If, instead, you need a timeout, for example to abort waiting for other receivers after
-a certain amount of time, you can use
-a [`timeout()`][frequenz.channels.timer.Timer.timeout] timer.
+a certain amount of time, you can use a [`Timer`][frequenz.channels.timer.Timer] like
+this:
 
 Example: Timeout
     ```python
@@ -42,7 +42,7 @@ async def main() -> None:
         channel = Anycast[int](name="data-channel")
         data_receiver = channel.new_receiver()
 
-        timer = Timer.timeout(timedelta(seconds=1.0))
+        timer = Timer(timedelta(seconds=1.0), SkipMissedAndDrift())
 
         async for selected in select(data_receiver, timer):
             if selected_from(selected, data_receiver):
@@ -472,14 +472,6 @@ class Timer(Receiver[timedelta]):
     [`missed_tick_policy`][frequenz.channels.timer.Timer.missed_tick_policy]. Missing
     ticks might or might not trigger a message and the drift could be accumulated or not
     depending on the chosen policy.
-
-    For the most common cases, a specialized constructor is provided:
-
-    * [`periodic()`][frequenz.channels.timer.Timer.periodic]:
-        {{docstring_summary("frequenz.channels.timer.Timer.periodic")}}
-
-    * [`timeout()`][frequenz.channels.timer.Timer.timeout]:
-        {{docstring_summary("frequenz.channels.timer.Timer.timeout")}}
     """
 
     def __init__(  # pylint: disable=too-many-arguments