From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 22 Apr 2021 04:32:40 +0000 (-0700)
Subject: bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH... 
X-Git-Tag: v3.9.5~66
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=87a392db40d52cba18ffc67730856e11cb8cf945;p=thirdparty%2FPython%2Fcpython.git

bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)

(cherry picked from commit 660592f67c0d825b06eb4a38ccc04b34a1f01f00)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
---

diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index 2fc170a0bc0b..26892c99268b 100755
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -1139,6 +1139,32 @@ The :mod:`socket` module also offers various network-related services:
       "Interface name" is a name as documented in :func:`if_nameindex`.
 
 
+.. function:: send_fds(sock, buffers, fds[, flags[, address]])
+
+   Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket *sock*.
+   The *fds* parameter is a sequence of file descriptors.
+   Consult :meth:`sendmsg` for the documentation of these parameters.
+
+   .. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
+
+   .. versionadded:: 3.9
+
+
+.. function:: recv_fds(sock, bufsize, maxfds[, flags])
+
+   Receive up to *maxfds* file descriptors from an :const:`AF_UNIX` socket *sock*.
+   Return ``(msg, list(fds), flags, addr)``.
+   Consult :meth:`recvmsg` for the documentation of these parameters.
+
+   .. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
+
+   .. versionadded:: 3.9
+
+   .. note::
+
+      Any truncated integers at the end of the list of file descriptors.
+
+
 .. _socket-objects:
 
 Socket Objects
@@ -1633,29 +1659,6 @@ to sockets.
 
    .. versionadded:: 3.6
 
-.. method:: socket.send_fds(sock, buffers, fds[, flags[, address]])
-
-   Send the list of file descriptors *fds* over an :const:`AF_UNIX` socket.
-   The *fds* parameter is a sequence of file descriptors.
-   Consult :meth:`sendmsg` for the documentation of these parameters.
-
-   .. availability:: Unix supporting :meth:`~socket.sendmsg` and :const:`SCM_RIGHTS` mechanism.
-
-   .. versionadded:: 3.9
-
-.. method:: socket.recv_fds(sock, bufsize, maxfds[, flags])
-
-   Receive up to *maxfds* file descriptors. Return ``(msg, list(fds), flags, addr)``. Consult
-   :meth:`recvmsg` for the documentation of these parameters.
-
-   .. availability:: Unix supporting :meth:`~socket.recvmsg` and :const:`SCM_RIGHTS` mechanism.
-
-   .. versionadded:: 3.9
-
-   .. note::
-
-      Any truncated integers at the end of the list of file descriptors.
-
 .. method:: socket.sendfile(file, offset=0, count=None)
 
    Send a file until EOF is reached by using high-performance
diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst
index d5eaccacde67..b39fdb5efdf5 100644
--- a/Doc/whatsnew/3.9.rst
+++ b/Doc/whatsnew/3.9.rst
@@ -658,7 +658,7 @@ The socket module now supports the :data:`~socket.CAN_J1939` protocol on
 platforms that support it.  (Contributed by Karl Ding in :issue:`40291`.)
 
 The socket module now has the :func:`socket.send_fds` and
-:func:`socket.recv.fds` methods. (Contributed by Joannah Nanjekye, Shinya
+:func:`socket.recv_fds` functions. (Contributed by Joannah Nanjekye, Shinya
 Okano and Victor Stinner in :issue:`28724`.)