Skip to content

Commit

Permalink
Amplifies the timeout warning in the docs.
Browse files Browse the repository at this point in the history
Partially addresses psf#3070.
  • Loading branch information
mlissner authored Nov 14, 2016
1 parent 33bd38b commit cfb7fd8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,9 @@ Timeouts
--------

You can tell Requests to stop waiting for a response after a given number of
seconds with the ``timeout`` parameter::
seconds with the ``timeout`` parameter. Nearly all production code should use
this parameter in nearly all requests. Failure to do so can cause your program
to hang indefinitely::

>>> requests.get('http://github.com', timeout=0.001)
Traceback (most recent call last):
Expand Down

0 comments on commit cfb7fd8

Please sign in to comment.