Improve documentation

src/frequenz/channels/_exceptions.py

@@ -79,7 +79,7 @@ def __init__(self, message: str):
         """Initialize this error.
 
         Args:
-            message: An error message.
+            message: The error message.
         """
         super().__init__(message)
 
@@ -94,8 +94,8 @@ def __init__(self, message: str, channel: Any):
         """Initialize this error.
 
         Args:
-            message: An error message.
-            channel: A reference to the channel that encountered the error.
+            message: The error message.
+            channel: The channel where the error happened.
         """
         super().__init__(message)
         self.channel: Any = channel
@@ -109,6 +109,6 @@ def __init__(self, channel: Any):
         """Initialize this error.
 
         Args:
-            channel: A reference to the channel that was closed.
+            channel: The channel that was closed.
         """
         super().__init__(f"Channel {channel} was closed", channel)

src/frequenz/channels/_receiver.py

@@ -194,7 +194,7 @@ def __aiter__(self) -> Self:
         """Initialize the async iterator over received values.
 
         Returns:
-            `self`, since no extra setup is needed for the iterator.
+            This receiver, as it is already an async iterator.
         """
         return self
 
@@ -235,7 +235,7 @@ def map(self, call: Callable[[_T_co], _U_co]) -> Receiver[_U_co]:
             original receiver and use that instead.
 
         Args:
-            call: function to apply on incoming messages.
+            call: The function to apply on incoming messages.
 
         Returns:
             A `Receiver` to read results of the given function from.
@@ -253,7 +253,7 @@ def __init__(self, message: str, receiver: Receiver[_T_co]):
         """Initialize this error.
 
         Args:
-            message: An error message.
+            message: The error message.
             receiver: The [Receiver][frequenz.channels.Receiver] where the
                 error happened.
         """

src/frequenz/channels/_sender.py

@@ -82,7 +82,7 @@ def __init__(self, message: str, sender: Sender[_T_contra]):
         """Initialize this error.
 
         Args:
-            message: An error message.
+            message: The error message.
             sender: The [Sender][frequenz.channels.Sender] where the error
                 happened.
         """

src/frequenz/channels/file_watcher.py

@@ -122,8 +122,8 @@ def __init__(
         """Initialize this file watcher.
 
         Args:
-            paths: Paths to watch for changes.
-            event_types: Types of events to watch for. Defaults to watch for
+            paths: The paths to watch for changes.
+            event_types: The types of events to watch for. Defaults to watch for
                 all event types.
         """
         self.event_types: frozenset[EventType] = frozenset(event_types)