summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2004-01-27 18:21:26 (GMT)
committerFred Drake <fdrake@acm.org>2004-01-27 18:21:26 (GMT)
commitfcc51767bd45a5fe63bb3f18cf493851d9dc8582 (patch)
treeb1c49110d1a606ba5d3c24f417196c093e1bab07
parent76beca957fbe8cceecabd8e30725b4ea0f0d024f (diff)
downloadcpython-fcc51767bd45a5fe63bb3f18cf493851d9dc8582.zip
cpython-fcc51767bd45a5fe63bb3f18cf493851d9dc8582.tar.gz
cpython-fcc51767bd45a5fe63bb3f18cf493851d9dc8582.tar.bz2
update signature of the socket constructor
(could someone backport this to Python 2.3.x please?)
-rw-r--r--Doc/lib/libsocket.tex12
1 files changed, 7 insertions, 5 deletions
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index 1c48108..18de5f2 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -276,12 +276,14 @@ for that service. The protocol name should be \code{'tcp'} or
\code{'udp'}.
\end{funcdesc}
-\begin{funcdesc}{socket}{family, type\optional{, proto}}
+\begin{funcdesc}{socket}{\optional{family\optional{,
+ type\optional{, proto}}}}
Create a new socket using the given address family, socket type and
-protocol number. The address family should be \constant{AF_INET}, \constant{AF_INET6} or
-\constant{AF_UNIX}. The socket type should be \constant{SOCK_STREAM},
-\constant{SOCK_DGRAM} or perhaps one of the other \samp{SOCK_} constants.
-The protocol number is usually zero and may be omitted in that case.
+protocol number. The address family should be \constant{AF_INET} (the
+default), \constant{AF_INET6} or \constant{AF_UNIX}. The socket type
+should be \constant{SOCK_STREAM} (the default), \constant{SOCK_DGRAM}
+or perhaps one of the other \samp{SOCK_} constants. The protocol
+number is usually zero and may be omitted in that case.
\end{funcdesc}
\begin{funcdesc}{ssl}{sock\optional{, keyfile, certfile}}