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

Document that WebSocketResponse.receive() raises asyncio.TimeoutError #3962

Open
antonagestam opened this issue Aug 6, 2019 · 4 comments
Open
Labels
documentation Improvements or additions to documentation enhancement good first issue Good for newcomers

Comments

@antonagestam
Copy link

antonagestam commented Aug 6, 2019

To be able to do anything useful with the timeout feature of WebSocketResponse.receive() you will probably want to catch the exceptions that occur. It's currently quite hard to find what exceptions will be raised on timeouts without digging through source code. I suggest documenting the fact.

Related issue: #2906
receive() in the documentation/reference: https://aiohttp.readthedocs.io/en/stable/web_reference.html#aiohttp.web.WebSocketResponse.receive

@asvetlov
Copy link
Member

.receive() can raise many exception types.
If you want to make a PR for docs fix -- you are welcome.

@Dreamsorcerer Dreamsorcerer added good first issue Good for newcomers documentation Improvements or additions to documentation labels Aug 16, 2024
@mhaoda
Copy link

mhaoda commented Oct 5, 2024

Can I give a try on this document enhancement?

@Dreamsorcerer
Copy link
Member

Of course. Seems like it should be a fairly simple change.

@mhaoda
Copy link

mhaoda commented Oct 6, 2024

Thanks, I'll work on it then.

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 enhancement good first issue Good for newcomers
Projects
Development

No branches or pull requests

4 participants