Skip to content

Commit cbac027

Browse files
committed
Index socket.socket on the methods entry, not the constructor
Drop :noindex: from the socket class in Socket Objects so socket.socket is indexed where its methods are documented, and add :noindex: to the constructor entry to avoid a duplicate object description.
1 parent 9e719a9 commit cbac027

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

Doc/library/socket.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -843,6 +843,7 @@ The following functions all create :ref:`socket objects <socket-objects>`.
843843

844844

845845
.. class:: socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
846+
:noindex:
846847

847848
Create a new socket using the given address family, socket type and protocol
848849
number. The address family should be :const:`AF_INET` (the default),
@@ -1533,7 +1534,6 @@ Socket Objects
15331534
--------------
15341535

15351536
.. class:: socket
1536-
:noindex:
15371537

15381538
Socket objects have the following methods. Except for
15391539
:meth:`~socket.makefile`, these correspond to Unix system calls applicable

0 commit comments

Comments
 (0)