Skip to content

Commit 995f1b6

Browse files
committed
fixup! Improve the _sender module description
1 parent cf08497 commit 995f1b6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/frequenz/channels/_sender.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
await sender.send("Hello, world!")
2020
```
2121
22-
Even when [`send()`][frequenz.channels.Sender.send] is an asynchronous method, some
23-
channels may implement it as a synchronously. For example, buffered channels that
24-
drop messages when the buffer is full could guarantee that
22+
Although [`send()`][frequenz.channels.Sender.send] is an asynchronous method, some
23+
channels may implement it in a synchronous, non-blocking way. For example, buffered
24+
channels that drop messages when the buffer is full could guarantee that
2525
[`send()`][frequenz.channels.Sender.send] never blocks. However, please keep in mind
2626
that the [asyncio][] event loop could give control to another task at any time,
2727
effectively making the [`send()`][frequenz.channels.Sender.send] method blocking.
@@ -58,7 +58,7 @@
5858

5959

6060
class Sender(ABC, Generic[_T]):
61-
"""An entity that sends values to a *channel*."""
61+
"""An endpoint to sends messages."""
6262

6363
@abstractmethod
6464
async def send(self, msg: _T) -> None:

0 commit comments

Comments
 (0)