[docs] Tweak parameter names for fcntl module (issue 22832)

storchaka at gmail.com storchaka at gmail.com
Fri Feb 27 16:05:11 CET 2015


https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst
File Doc/library/fcntl.rst (right):

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode37
Doc/library/fcntl.rst:37: header files.  The argument *arg* is optional,
and defaults to the integer
May be change signature to Python-compatible "fcntl(fd, cmd[, arg=0)"
and remove sentences about default values?

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode38
Doc/library/fcntl.rst:38: value ``0``.  When present, it can either be
an integer value, or a string.
This is Python 2 legacy. Should be "bytes". Strings are supported too,
but we should deprecate this.

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode41
Doc/library/fcntl.rst:41: a string it represents a binary structure,
e.g. created by :func:`struct.pack`.
bytes

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode44
Doc/library/fcntl.rst:44: of the buffer, converted to a string object. 
The length of the returned string
Return value is bytes instance.

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode58
Doc/library/fcntl.rst:58: The op parameter is limited to values that can
fit in 32-bits.
"The op parameter" -- not updated.

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode63
Doc/library/fcntl.rst:63: The parameter *arg* can be one of an integer,
absent (treated identically to the
Same as above about default value.

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode64
Doc/library/fcntl.rst:64: integer ``0``), an object supporting the
read-only buffer interface (most likely
"(most likely a plain Python string)" -- incorrect. Should be "(like
:class:`bytes`)".

https://bugs.python.org/review/22832/diff/14034/Doc/library/fcntl.rst#newcode65
Doc/library/fcntl.rst:65: a plain Python string) or an object supporting
the read-write buffer interface.
May be add "(like :class:`bytearray`)".

https://bugs.python.org/review/22832/


More information about the docs mailing list