Add some noqa for exceptions we raise indirectly

There is a new check in `pydoclint` that checks all exceptions in the
docs are actually raised directly in the function body, but we sometimes
want to document exceptions raised indirectly too.

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

Author: llucax

src/frequenz/channels/_receiver.py

@@ -164,7 +164,9 @@
 class Receiver(ABC, Generic[ReceiverMessageT_co]):
     """An endpoint to receive messages."""
 
-    async def __anext__(self) -> ReceiverMessageT_co:
+    # We need the noqa here because ReceiverError can be raised by ready() and consume()
+    # implementations.
+    async def __anext__(self) -> ReceiverMessageT_co:  # noqa: DOC503
         """Await the next message in the async iteration over received messages.
 
         Returns:
@@ -215,7 +217,9 @@ def __aiter__(self) -> Self:
         """
         return self
 
-    async def receive(self) -> ReceiverMessageT_co:
+    # We need the noqa here because ReceiverError can be raised by consume()
+    # implementations.
+    async def receive(self) -> ReceiverMessageT_co:  # noqa: DOC503
         """Receive a message.
 
         Returns:

src/frequenz/channels/_select.py

@@ -196,8 +196,10 @@ def __init__(self, receiver: Receiver[ReceiverMessageT_co], /) -> None:
         self._handled: bool = False
         """Flag to indicate if this selected has been handled in the if-chain."""
 
+    # We need the noqa here because pydoclint can't figure out raise self._exception
+    # actually raise an Exception.
     @property
-    def message(self) -> ReceiverMessageT_co:
+    def message(self) -> ReceiverMessageT_co:  # noqa: DOC503
         """The message that was received, if any.
 
         Returns:
@@ -339,7 +341,11 @@ def __init__(self, selected: Selected[ReceiverMessageT_co]) -> None:
 # https://github.com/python/mypy/issues/13597
 
 
-async def select(*receivers: Receiver[Any]) -> AsyncIterator[Selected[Any]]:
+# We need the noqa here because BaseExceptionGroup can be raised indirectly by
+# _stop_pending_tasks.
+async def select(  # noqa: DOC503
+    *receivers: Receiver[Any],
+) -> AsyncIterator[Selected[Any]]:
     """Iterate over the messages of all receivers as they receive new messages.
 
     This function is used to iterate over the messages of all receivers as they receive

src/frequenz/channels/timer.py

@@ -466,7 +466,8 @@ class Timer(Receiver[timedelta]):
     depending on the chosen policy.
     """
 
-    def __init__(  # pylint: disable=too-many-arguments
+    # We need the noqa here because RuntimeError is raised indirectly.
+    def __init__(  # noqa: DOC503 pylint: disable=too-many-arguments
         self,
         interval: timedelta,
         missed_tick_policy: MissedTickPolicy,
@@ -586,7 +587,8 @@ def is_running(self) -> bool:
         """Whether the timer is running."""
         return not self._stopped
 
-    def reset(
+    # We need the noqa here because RuntimeError is raised indirectly.
+    def reset(  # noqa: DOC503
         self,
         *,
         interval: timedelta | None = None,