Further documentation updates to be consistent with doc standards and comments

Ezio Melotti pointed out.

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 7ce7705a11e85be8fd17e99410936fc8988df2f5..afc674cd69d0d56f2e7f789b08d9a65ac269ed76 100644 (file)
--- 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.

diff --git a/Misc/NEWS b/Misc/NEWS
index 6ebb33a8f99ca399732791d936d5300239ddcb63..133fecd81e605ed936264ddb783945b2d60fa6c2 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -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 8107b98efb168a80d0daabe8084ef48b00181e6d..a96ec069294ad9ecbc73ab91f8aae8839ecfdbec 100644 (file)
--- 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!");