From cfb7fd8f28b2d5ba98ffb659e8f3f3dd05b97754 Mon Sep 17 00:00:00 2001 From: Mike Lissner Date: Mon, 14 Nov 2016 09:57:08 -0800 Subject: [PATCH] Amplifies the timeout warning in the docs. Partially addresses #3070. --- docs/user/quickstart.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index c4b739ab..88c6df78 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -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):