SF patch #760257: add socket.timeout exception

rhettinger · rhettinger · commit be2528d8668f · 2003-06-29T04:55:59.000Z
(Contributed by Bob Halley)

Add documentation for the new socket.timeout exception.
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
@@ -109,6 +109,14 @@ \section{\module{socket} ---
 by the \cfunction{gai_strerror()} C function.
 \end{excdesc}
 
+\begin{excdesc}{timeout}
+This exception is raised when a timeout occurs on a socket which has
+had timeouts enabled via a prior call to \method{settimeout()}.  The
+accompanying value is a string whose value is currently always ``timed
+out''.
+\versionadded{2.3}
+\end{excdesc}
+
 \begin{datadesc}{AF_UNIX}
 \dataline{AF_INET}
 \dataline{AF_INET6}
@@ -579,7 +587,7 @@ \subsection{Socket Objects \label{socket-objects}}
 Set a timeout on blocking socket operations.  The \var{value} argument
 can be a nonnegative float expressing seconds, or \code{None}.
 If a float is
-given, subsequent socket operations will raise an \exception{error}
+given, subsequent socket operations will raise an \exception{timeout}
 exception if the timeout period \var{value} has elapsed before the
 operation has completed.  Setting a timeout of \code{None} disables
 timeouts on socket operations.
