]> granicus.if.org Git - python/commitdiff
update signature of the socket constructor
authorFred Drake <fdrake@acm.org>
Tue, 27 Jan 2004 18:21:26 +0000 (18:21 +0000)
committerFred Drake <fdrake@acm.org>
Tue, 27 Jan 2004 18:21:26 +0000 (18:21 +0000)
(could someone backport this to Python 2.3.x please?)

Doc/lib/libsocket.tex

index 1c48108f6d02a33ac0553b55e320204900c780a1..18de5f201fa66fe09b5ee4838aa2a7e3139f9a3a 100644 (file)
@@ -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}}