Further documentation updates to be consistent with doc standards and comments

Ezio Melotti pointed out.
This commit is contained in:
Gregory P. Smith 2011-05-22 22:47:55 -07:00
parent a454ef6985
commit b6471db8a7
3 changed files with 11 additions and 11 deletions

View file

@ -538,9 +538,9 @@ The module :mod:`socket` exports the following constants and functions:
.. function:: if_nameindex() .. function:: if_nameindex()
Returns a list of network interface information Return a list of network interface information
(index, name as a string) tuples. (index int, name string) tuples.
:exc:`socket.error` if the system call fails for any reason. :exc:`socket.error` if the system call fails.
Availability: Unix. Availability: Unix.
@ -549,8 +549,8 @@ The module :mod:`socket` exports the following constants and functions:
.. function:: if_nametoindex(if_name) .. function:: if_nametoindex(if_name)
Returns a network interface index number corresponding to an Return a network interface index number corresponding to an
interface name string. interface name.
:exc:`socket.error` if no interface with the given name exists. :exc:`socket.error` if no interface with the given name exists.
Availability: Unix. Availability: Unix.
@ -560,8 +560,8 @@ The module :mod:`socket` exports the following constants and functions:
.. function:: if_indextoname(if_index) .. function:: if_indextoname(if_index)
Returns a network interface name string corresponding to a Return a network interface name corresponding to a
interface index. interface index number.
:exc:`socket.error` if no interface with the given index exists. :exc:`socket.error` if no interface with the given index exists.
Availability: Unix. Availability: Unix.

View file

@ -13,8 +13,8 @@ Core and Builtins
- Issue #12060: Use sig_atomic_t type and volatile keyword in the signal - Issue #12060: Use sig_atomic_t type and volatile keyword in the signal
module. Patch written by Charles-François Natali. module. Patch written by Charles-François Natali.
- Added the if_nameindex, if_indextoname, if_nametoindex methods to - Issue #1746656: Added the if_nameindex, if_indextoname, if_nametoindex
the socket module as requested in issue #1746656. methods to the socket module.
- Issue #12044: Fixed subprocess.Popen when used as a context manager to - 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 wait for the process to end when exiting the context to avoid unintentionally

View file

@ -137,8 +137,8 @@ setsockopt(level, optname, value) -- set socket options\n\
settimeout(None | float) -- set or clear the timeout\n\ settimeout(None | float) -- set or clear the timeout\n\
shutdown(how) -- shut down traffic in one or both directions\n\ shutdown(how) -- shut down traffic in one or both directions\n\
if_nameindex() -- return all network interface indices and names\n\ if_nameindex() -- return all network interface indices and names\n\
if_nametoindex(name) -- returns the corresponding interface index\n\ if_nametoindex(name) -- return the corresponding interface index\n\
if_indextoname(index) -- returns the corresponding interface name\n\ if_indextoname(index) -- return the corresponding interface name\n\
\n\ \n\
[*] not available on all platforms!"); [*] not available on all platforms!");