Skip to content

Some docstring editing #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2024
Merged

Some docstring editing #413

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ydb/_topic_reader/topic_reader_sync.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ def receive_message(self, *, timeout: TimeoutType = None) -> datatypes.PublicMes

def async_wait_message(self) -> concurrent.futures.Future:
"""
Return future, which will completed when the reader has least one message in queue.
If reader already has message - future will return completed.
Returns a future, which will complete when the reader has at least one message in queue.
If the reader already has a message - the future will complete immediately.

Possible situation when receive signal about message available, but no messages when try to receive a message.
If message expired between send event and try to retrieve message (for example connection broken).
A message may expire before it gets read so that the attempt to receive the massage will fail
despite the future has signaled about its availability.
"""
self._check_closed()

Expand Down