summaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
authorMaik Himstedt <maik.himstedt@gmail.com>2016-08-17 20:27:00 +0200
committerMaik <maik.himstedt@gmail.com>2016-08-17 20:27:00 +0200
commitb26606cc3cb5c598819bc3be474368e7d4ecc0d2 (patch)
treee16c64e628afd8e40c6ccb4848b27392ac7cdd3f /docs/user
parent13bc52f82c687e4f184ee1400adf14275ad48e9e (diff)
downloadpython-requests-b26606cc3cb5c598819bc3be474368e7d4ecc0d2.tar.gz
Adding notes about Request's timeout behavior.
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/advanced.rst3
-rw-r--r--docs/user/quickstart.rst3
2 files changed, 4 insertions, 2 deletions
diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst
index d6d04569..3f39f1aa 100644
--- a/docs/user/advanced.rst
+++ b/docs/user/advanced.rst
@@ -910,7 +910,8 @@ Timeouts
--------
Most requests to external servers should have a timeout attached, in case the
-server is not responding in a timely manner. Without a timeout, your code may
+server is not responding in a timely manner. By standard, requests do not time
+out unless a timeout value is set explicitly. Without a timeout, your code may
hang for minutes or more.
The **connect** timeout is the number of seconds Requests will wait for your
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
index 0d725389..78134564 100644
--- a/docs/user/quickstart.rst
+++ b/docs/user/quickstart.rst
@@ -497,7 +497,8 @@ seconds with the ``timeout`` parameter::
``timeout`` is not a time limit on the entire response download;
rather, an exception is raised if the server has not issued a
response for ``timeout`` seconds (more precisely, if no bytes have been
- received on the underlying socket for ``timeout`` seconds).
+ received on the underlying socket for ``timeout`` seconds). If NO timeout is specified explicitly, requests do
+ not time out.
Errors and Exceptions