Adding socket module shutdown() argument description

Damien-Chen · Aug 1, 2024 · a332097 · a332097
1 parent 60d0b96
commit a332097
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
@@ -704,6 +704,10 @@ Constants
 
    .. versionadded:: 3.12
 
+.. data:: SHUT_RD
+          SHUT_WR
+          SHUT_RDWR
+   These argument are used to the `~socket.shutdown()`` method of socket object.
 
 Functions
 ^^^^^^^^^
@@ -1968,9 +1972,9 @@ to sockets.
 
 .. method:: socket.shutdown(how)
 
-   Shut down one or both halves of the connection.  If *how* is :const:`SHUT_RD`,
-   further receives are disallowed.  If *how* is :const:`SHUT_WR`, further sends
-   are disallowed.  If *how* is :const:`SHUT_RDWR`, further sends and receives are
+   Shut down one or both halves of the connection.  If *how* is :const:`~SHUT_RD`,
+   further receives are disallowed.  If *how* is :const:`~SHUT_WR`, further sends
+   are disallowed.  If *how* is :const:`~SHUT_RDWR`, further sends and receives are
    disallowed.
 
    .. availability:: not WASI.