[Python-checkins] python/dist/src/Modules socketmodule.c,1.240,1.241

2002年8月08日 13:37:10 -0700

Update of /cvsroot/python/python/dist/src/Modules
In directory usw-pr-cvs1:/tmp/cvs-serv13210
Modified Files:
	socketmodule.c 
Log Message:
Clean up some docstrings. Some docstrings didn't show their return
value; others were inconsistent in what to name the argument or return
value; a few module-global functions had "socket." in front of their
name, against convention.
Index: socketmodule.c
===================================================================
RCS file: /cvsroot/python/python/dist/src/Modules/socketmodule.c,v
retrieving revision 1.240
retrieving revision 1.241
diff -C2 -d -r1.240 -r1.241
*** socketmodule.c	6 Aug 2002 22:25:02 -0000	1.240
--- socketmodule.c	8 Aug 2002 20:37:08 -0000	1.241
***************
*** 1111,1115 ****

 PyDoc_STRVAR(gettimeout_doc,
! "gettimeout()\n\
 \n\
 Returns the timeout in floating seconds associated with socket \n\
--- 1111,1115 ----

 PyDoc_STRVAR(gettimeout_doc,
! "gettimeout() -> timeout\n\
 \n\
 Returns the timeout in floating seconds associated with socket \n\
***************
*** 1388,1392 ****

 PyDoc_STRVAR(connect_ex_doc,
! "connect_ex(address)\n\
 \n\
 This is like connect(address), but returns an error code (the errno value)\n\
--- 1388,1392 ----

 PyDoc_STRVAR(connect_ex_doc,
! "connect_ex(address) -> errno\n\
 \n\
 This is like connect(address), but returns an error code (the errno value)\n\
***************
*** 1788,1792 ****

 PyDoc_STRVAR(sendto_doc,
! "sendto(data[, flags], address)\n\
 \n\
 Like send(data, flags) but allows specifying the destination address.\n\
--- 1788,1792 ----

 PyDoc_STRVAR(sendto_doc,
! "sendto(data[, flags], address) -> count\n\
 \n\
 Like send(data, flags) but allows specifying the destination address.\n\
***************
*** 2713,2718 ****

 PyDoc_STRVAR(getaddrinfo_doc,
! "socket.getaddrinfo(host, port [, family, socktype, proto, flags])\n\
! 	--> List of (family, socktype, proto, canonname, sockaddr)\n\
 \n\
 Resolve host and port into addrinfo struct.");
--- 2713,2718 ----

 PyDoc_STRVAR(getaddrinfo_doc,
! "getaddrinfo(host, port [, family, socktype, proto, flags])\n\
! -> list of (family, socktype, proto, canonname, sockaddr)\n\
 \n\
 Resolve host and port into addrinfo struct.");
***************
*** 2791,2795 ****

 PyDoc_STRVAR(getnameinfo_doc,
! "socket.getnameinfo(sockaddr, flags) --> (host, port)\n\
 \n\
 Get host and port for a sockaddr.");
--- 2791,2795 ----

 PyDoc_STRVAR(getnameinfo_doc,
! "getnameinfo(sockaddr, flags) --> (host, port)\n\
 \n\
 Get host and port for a sockaddr.");
***************
*** 2810,2814 ****

 PyDoc_STRVAR(getdefaulttimeout_doc,
! "socket.getdefaulttimeout() -> None | float\n\
 \n\
 Returns the default timeout in floating seconds for new socket objects.\n\
--- 2810,2814 ----

 PyDoc_STRVAR(getdefaulttimeout_doc,
! "getdefaulttimeout() -> timeout\n\
 \n\
 Returns the default timeout in floating seconds for new socket objects.\n\
***************
*** 2840,2844 ****

 PyDoc_STRVAR(setdefaulttimeout_doc,
! "socket.setdefaulttimeout(None | float)\n\
 \n\
 Set the default timeout in floating seconds for new socket objects.\n\
--- 2840,2844 ----

 PyDoc_STRVAR(setdefaulttimeout_doc,
! "setdefaulttimeout(timeout)\n\
 \n\
 Set the default timeout in floating seconds for new socket objects.\n\
***************
*** 3014,3019 ****

 PyDoc_STRVAR(socket_doc,
! "Implementation module for socket operations. See the socket module\n\
! for documentation.");

 PyMODINIT_FUNC
--- 3014,3020 ----

 PyDoc_STRVAR(socket_doc,
! "Implementation module for socket operations.\n\
! \n\
! See the socket module for documentation.");

 PyMODINIT_FUNC