diff options
| author | Gregory P. Smith <greg@krypto.org> | 2011-05-22 22:47:55 -0700 |
|---|---|---|
| committer | Gregory P. Smith <greg@krypto.org> | 2011-05-22 22:47:55 -0700 |
| commit | b6471db8a76416b2eb49fe9b02c6f9f9a6502b4d (patch) | |
| tree | 7118828beac9b9420395c42c81dba39c9b735863 | |
| parent | a454ef6985494ad894c5ec7ebe0ea4c824fc926d (diff) | |
| download | cpython-git-b6471db8a76416b2eb49fe9b02c6f9f9a6502b4d.tar.gz | |
Further documentation updates to be consistent with doc standards and comments
Ezio Melotti pointed out.
| -rw-r--r-- | Doc/library/socket.rst | 14 | ||||
| -rw-r--r-- | Misc/NEWS | 4 | ||||
| -rw-r--r-- | Modules/socketmodule.c | 4 |
3 files changed, 11 insertions, 11 deletions
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst index 7ce7705a11..afc674cd69 100644 --- a/Doc/library/socket.rst +++ b/Doc/library/socket.rst @@ -538,9 +538,9 @@ The module :mod:`socket` exports the following constants and functions: .. function:: if_nameindex() - Returns a list of network interface information - (index, name as a string) tuples. - :exc:`socket.error` if the system call fails for any reason. + Return a list of network interface information + (index int, name string) tuples. + :exc:`socket.error` if the system call fails. Availability: Unix. @@ -549,8 +549,8 @@ The module :mod:`socket` exports the following constants and functions: .. function:: if_nametoindex(if_name) - Returns a network interface index number corresponding to an - interface name string. + Return a network interface index number corresponding to an + interface name. :exc:`socket.error` if no interface with the given name exists. Availability: Unix. @@ -560,8 +560,8 @@ The module :mod:`socket` exports the following constants and functions: .. function:: if_indextoname(if_index) - Returns a network interface name string corresponding to a - interface index. + Return a network interface name corresponding to a + interface index number. :exc:`socket.error` if no interface with the given index exists. Availability: Unix. @@ -13,8 +13,8 @@ Core and Builtins - Issue #12060: Use sig_atomic_t type and volatile keyword in the signal module. Patch written by Charles-François Natali. -- Added the if_nameindex, if_indextoname, if_nametoindex methods to - the socket module as requested in issue #1746656. +- Issue #1746656: Added the if_nameindex, if_indextoname, if_nametoindex + methods to the socket module. - Issue #12044: Fixed subprocess.Popen when used as a context manager to wait for the process to end when exiting the context to avoid unintentionally diff --git a/Modules/socketmodule.c b/Modules/socketmodule.c index 8107b98efb..a96ec06929 100644 --- a/Modules/socketmodule.c +++ b/Modules/socketmodule.c @@ -137,8 +137,8 @@ setsockopt(level, optname, value) -- set socket options\n\ settimeout(None | float) -- set or clear the timeout\n\ shutdown(how) -- shut down traffic in one or both directions\n\ if_nameindex() -- return all network interface indices and names\n\ -if_nametoindex(name) -- returns the corresponding interface index\n\ -if_indextoname(index) -- returns the corresponding interface name\n\ +if_nametoindex(name) -- return the corresponding interface index\n\ +if_indextoname(index) -- return the corresponding interface name\n\ \n\ [*] not available on all platforms!"); |