Skip to content

Commit 2e50b98

Browse files
committed
Add missing Returns section to consume()
Even when the body is not returning anything in this case, the docs should specify what could happen in general. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent fb7488e commit 2e50b98

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/frequenz/channels/_base_classes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,10 @@ def into_peekable(self) -> Peekable[T]:
130130
Once this function has been called, the receiver will no longer be
131131
usable, and calling `receive` on the receiver will raise an exception.
132132
133+
Returns:
134+
A `Peekable` that can be used to peek at the latest value in the
135+
channel.
136+
133137
Raises:
134138
NotImplementedError: when a `Receiver` implementation doesn't have
135139
a custom `into_peekable` implementation.

0 commit comments

Comments
 (0)