Commit 24a61098 authored by Berker Peksag's avatar Berker Peksag

Issue #16802: Document fileno parameter of socket.socket()

Patch by Henrik Heimbuerger and Bar Harel.
parent 9955a373
......@@ -369,7 +369,11 @@ The following functions all create :ref:`socket objects <socket-objects>`.
:const:`SOCK_DGRAM`, :const:`SOCK_RAW` or perhaps one of the other ``SOCK_``
constants. The protocol number is usually zero and may be omitted or in the
case where the address family is :const:`AF_CAN` the protocol should be one
of :const:`CAN_RAW` or :const:`CAN_BCM`.
of :const:`CAN_RAW` or :const:`CAN_BCM`. If *fileno* is specified, the other
arguments are ignored, causing the socket with the specified file descriptor
to return. Unlike :func:`socket.fromfd`, *fileno* will return the same
socket and not a duplicate. This may help close a detached socket using
:meth:`socket.close()`.
The newly created socket is :ref:`non-inheritable <fd_inheritance>`.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment