Skip to content

Commit 9aad87a

Browse files
authored
Merge pull request #413 Some docstring editing from krokoziabla/main
Some docstring editing
2 parents ce138f8 + d78b5a9 commit 9aad87a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

ydb/_topic_reader/topic_reader_sync.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ def receive_message(self, *, timeout: TimeoutType = None) -> datatypes.PublicMes
7676

7777
def async_wait_message(self) -> concurrent.futures.Future:
7878
"""
79-
Return future, which will completed when the reader has least one message in queue.
80-
If reader already has message - future will return completed.
79+
Returns a future, which will complete when the reader has at least one message in queue.
80+
If the reader already has a message - the future will complete immediately.
8181
82-
Possible situation when receive signal about message available, but no messages when try to receive a message.
83-
If message expired between send event and try to retrieve message (for example connection broken).
82+
A message may expire before it gets read so that the attempt to receive the massage will fail
83+
despite the future has signaled about its availability.
8484
"""
8585
self._check_closed()
8686

0 commit comments

Comments
 (0)