Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

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

Patch by Henrik Heimbuerger and Bar Harel.
This commit is contained in:
Berker Peksag 2015-10-08 06:34:57 +03:00
parent c2432f6edb ce88d82ec2
commit 2137dc1573
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/library/socket.rst
View File

@ -384,7 +384,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>`.