List specific timeouts for each exception (#8968)

(cherry picked from commit 8daecf5)
aio-libs · Sep 2, 2024 · c8bdac8 · c8bdac8
1 parent 2af23ab
commit c8bdac8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/CHANGES/8968.doc.rst b/CHANGES/8968.doc.rst
@@ -0,0 +1 @@
+Clarified which timeout exceptions happen on which timeouts -- by :user:`Dreamsorcerer`.
diff --git a/docs/client_reference.rst b/docs/client_reference.rst
@@ -2327,17 +2327,20 @@ Connection errors
 
    Server operation timeout: read timeout, etc.
 
+   To catch all timeouts, including the ``total`` timeout, use
+   :exc:`asyncio.TimeoutError`.
+
    Derived from :exc:`ServerConnectionError` and :exc:`asyncio.TimeoutError`
 
 .. class:: ConnectionTimeoutError
 
-   Connection timeout on request: e.g. read timeout.
+   Connection timeout on ``connect`` and ``sock_connect`` timeouts.
 
    Derived from :exc:`ServerTimeoutError`
 
 .. class:: SocketTimeoutError
 
-   Reading from socket timeout.
+   Reading from socket timeout on ``sock_read`` timeout.
 
    Derived from :exc:`ServerTimeoutError`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarified which timeout exceptions happen on which timeouts -- by :user:`Dreamsorcerer`.