From b26606cc3cb5c598819bc3be474368e7d4ecc0d2 Mon Sep 17 00:00:00 2001 From: Maik Himstedt Date: Wed, 17 Aug 2016 20:27:00 +0200 Subject: [PATCH 1/2] Adding notes about Request's timeout behavior. --- AUTHORS.rst | 3 +++ docs/user/advanced.rst | 3 ++- docs/user/quickstart.rst | 3 ++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index b0ddcabb..ca062664 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -159,11 +159,14 @@ Patches and Suggestions - Muhammad Yasoob Ullah Khalid (`@yasoob `_) - Paul van der Linden (`@pvanderlinden `_) - Colin Dickson (`@colindickson `_) +- Sabari Kumar Murugesan (`@neosab `_) - Smiley Barry (`@smiley `_) - Shagun Sodhani (`@shagunsodhani `_) - Robin Linderborg (`@vienno `_) - Brian Samek (`@bsamek `_) - Dmitry Dygalo (`@Stranger6667 `_) +- Tomáš Heger (`@geckon `_) - piotrjurkiewicz - Jesse Shapiro (`@haikuginger `_) - Nate Prewitt (`@nateprewitt `_) +- Maik Himstedt 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 From b5fac316885767b6c00c6b1199de5c8695513fdf Mon Sep 17 00:00:00 2001 From: Maik Date: Wed, 17 Aug 2016 22:03:18 +0200 Subject: [PATCH 2/2] Changes to documentation based on comments and correction of list of authors. --- AUTHORS.rst | 2 -- docs/user/advanced.rst | 2 +- docs/user/quickstart.rst | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index ca062664..0654190b 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -159,13 +159,11 @@ Patches and Suggestions - Muhammad Yasoob Ullah Khalid (`@yasoob `_) - Paul van der Linden (`@pvanderlinden `_) - Colin Dickson (`@colindickson `_) -- Sabari Kumar Murugesan (`@neosab `_) - Smiley Barry (`@smiley `_) - Shagun Sodhani (`@shagunsodhani `_) - Robin Linderborg (`@vienno `_) - Brian Samek (`@bsamek `_) - Dmitry Dygalo (`@Stranger6667 `_) -- Tomáš Heger (`@geckon `_) - piotrjurkiewicz - Jesse Shapiro (`@haikuginger `_) - Nate Prewitt (`@nateprewitt `_) diff --git a/docs/user/advanced.rst b/docs/user/advanced.rst index 3f39f1aa..343ba0ec 100644 --- a/docs/user/advanced.rst +++ b/docs/user/advanced.rst @@ -910,7 +910,7 @@ Timeouts -------- Most requests to external servers should have a timeout attached, in case the -server is not responding in a timely manner. By standard, requests do not time +server is not responding in a timely manner. By default, requests do not time out unless a timeout value is set explicitly. Without a timeout, your code may hang for minutes or more. diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index 78134564..c4b739ab 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -497,7 +497,7 @@ 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). If NO timeout is specified explicitly, requests do + received on the underlying socket for ``timeout`` seconds). If no timeout is specified explicitly, requests do not time out.