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

Docs: Mention that timeouts are in seconds #4190

Closed
polcak opened this issue Oct 16, 2019 · 4 comments
Closed

Docs: Mention that timeouts are in seconds #4190

polcak opened this issue Oct 16, 2019 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/

Comments

@polcak
Copy link
Contributor

polcak commented Oct 16, 2019

The docs such as https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientTimeout does not mention what are the units for the timeout, are these second, miliseconds, minutes?

Looking at https://docs.aiohttp.org/en/stable/client_quickstart.html#aiohttp-client-timeouts I figured out that timeouts are specified as seconds but only after reading to the very botom. Even there the units are not mentioned but rather the docs mention "By default aiohttp uses a total 5min timeout" and "Thus the default timeout is: aiohttp.ClientTimeout(total=5*60, connect=None,
sock_connect=None, sock_read=None)"

Expected behaviour

Please specify the units explicitely, e.g.: "Total number of seconds for the whole request." rather than "Total timeout for the whole request."

@asvetlov asvetlov added documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/ labels Oct 16, 2019
@asvetlov
Copy link
Member

Pull request is welcome!

@codepr
Copy link
Contributor

codepr commented Oct 16, 2019

Hello, thanks for the great work with the library, addressed the issue on #4194 .

polcak added a commit to polcak/aiohttp that referenced this issue Oct 16, 2019
@polcak polcak mentioned this issue Oct 16, 2019
5 tasks
@polcak
Copy link
Contributor Author

polcak commented Oct 16, 2019

Pull request #4197 addresses more occurrences of the missing unit than #4194.

asvetlov pushed a commit that referenced this issue Oct 19, 2019
@asvetlov
Copy link
Member

Fixed I guess

asvetlov pushed a commit that referenced this issue Oct 19, 2019
(cherry picked from commit 564d9cc)

Co-authored-by: polcak <ipolcak@fit.vutbr.cz>
asvetlov added a commit that referenced this issue Oct 19, 2019
(cherry picked from commit 564d9cc)

Co-authored-by: polcak <ipolcak@fit.vutbr.cz>
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 good first issue Good for newcomers Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/
Projects
None yet
Development

No branches or pull requests

3 participants