docs: Indent "Returns:" properly

Then "Returns:" uses more than one line, it should be indented one level
more to mark the continuation of one return specification, as it is
possible to have multiple return specifications.

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

Author: llucax

src/frequenz/channels/anycast.py

@@ -134,8 +134,8 @@ async def send(self, msg: T) -> bool:
             msg: The message to be sent.
 
         Returns:
-            Boolean indicating whether the message was sent, based on whether
-            the channel is open or not.
+            Whether the message was sent, based on whether the channel is open
+                or not.
         """
         if self._chan.closed:
             return False

src/frequenz/channels/base_classes.py

@@ -24,7 +24,7 @@ async def send(self, msg: T) -> bool:
 
         Returns:
             Whether the message was sent, based on whether the channel is open
-            or not.
+                or not.
         """
 
 
@@ -103,8 +103,8 @@ def peek(self) -> Optional[T]:
         """Return the latest value that was sent to the channel.
 
         Returns:
-            The latest value received by the channel, and None, if nothing has
-            been sent to the channel yet.
+            The latest value received by the channel, and `None`, if nothing
+                has been sent to the channel yet.
         """
 
 

src/frequenz/channels/broadcast.py

@@ -320,7 +320,7 @@ def peek(self) -> Optional[T]:
         """Return the latest value that was sent to the channel.
 
         Returns:
-            The latest value received by the channel, and None, if nothing has
-            been sent to the channel yet, or if the channel is closed.
+            The latest value received by the channel, and `None`, if nothing
+                has been sent to the channel yet, or if the channel is closed.
         """
         return self._chan._latest  # pylint: disable=protected-access

src/frequenz/channels/merge.py

@@ -48,8 +48,8 @@ async def receive(self) -> Optional[T]:
         """Wait until there's a message in any of the channels.
 
         Returns:
-            The next message that was received, or None, if all channels have
-            closed.
+            The next message that was received, or `None`, if all channels have
+                closed.
         """
         # we use a while loop to continue to wait for new data, in case the
         # previous `wait` completed because a channel was closed.

src/frequenz/channels/merge_named.py

@@ -35,8 +35,8 @@ async def receive(self) -> Optional[Tuple[str, T]]:
         """Wait until there's a message in any of the channels.
 
         Returns:
-            The next message that was received, or None, if all channels have
-            closed.
+            The next message that was received, or `None`, if all channels have
+                closed.
         """
         # we use a while loop to continue to wait for new data, in case the
         # previous `wait` completed because a channel was closed.