From 10d7fc8bed59ab5ebaf2d84e3c0be108cfb8b9c5 Mon Sep 17 00:00:00 2001 From: CodeLine9 Date: Mon, 20 Apr 2026 07:22:50 +0800 Subject: [PATCH] docs(quickstart): clarify timeout applies to connect and read separately The quickstart timeout section didn't explain that a single float value applies to both connect and read timeouts independently, or that a tuple can be used to set them separately. Added a brief clarification with a cross-reference to the advanced timeouts section. --- docs/user/quickstart.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst index cef9e088d8..d78be35a79 100644 --- a/docs/user/quickstart.rst +++ b/docs/user/quickstart.rst @@ -548,6 +548,11 @@ to hang indefinitely:: received on the underlying socket for ``timeout`` seconds). If no timeout is specified explicitly, requests do not time out. + A single ``timeout`` value applies to both the **connect** and + **read** phases separately. To set them independently, pass a + ``(connect_timeout, read_timeout)`` tuple. See :ref:`timeouts` + for details. + Errors and Exceptions ---------------------