Skip to content
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.

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

Update get_message doc to avoid confusion #151

Open
aiven-sal opened this issue Dec 13, 2024 · 1 comment
Open

Update get_message doc to avoid confusion #151

aiven-sal opened this issue Dec 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@aiven-sal
Copy link
Member

As reported in #150 the current get_message behavior is confusing.
Some people would reasonably expect it to default to being blocking.
We should state this more explicitly in the documentation.

We should also take a look at the rest of the code to see if there are other places with similar issues.

@aiven-sal aiven-sal added the documentation Improvements or additions to documentation label Dec 13, 2024
@aiven-sal
Copy link
Member Author

We should also consider adding a run time warning as suggested in #150 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant