[docs] Behavior of ZipFile with file-like object and BufferedWriter. (issue 20699)

rdmurray at bitdance.com rdmurray at bitdance.com
Thu Feb 19 22:12:27 CET 2015


http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst
File Doc/library/io.rst (right):

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode396
Doc/library/io.rst:396: :term:`bytes-like <bytes-like object>` buffer
*b*, and return the
I think 'buffer' should be 'object'.

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode404
Doc/library/io.rst:404: be less than the number of bytes in *b*,
I think len(b) is better here.  It is more precise..."number of bytes"
might refer to something other than the length of the buffer.

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode481
Doc/library/io.rst:481: <bytes-like object>` buffer *b* and return the
number of bytes read.
Why drop the 'len'?  It is more precise.

Again I prefer object to buffer.

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode492
Doc/library/io.rst:492: <bytes-like object>` buffer *b*, using at most
one call to
As above.

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode504
Doc/library/io.rst:504: of bytes written (always equal to the number of
bytes in *b*, since if
Do you understand the reason for the original wording?  Are there
circumstances where more bytes are written?

And again, I prefer 'len(b)' to 'number of bytes in b'.

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode589
Doc/library/io.rst:589: optional initial :term:`bytes-like object` data.
This should be "The argument *initial_bytes* is a :term:`bytes-like
object` that contains initial data."

http://bugs.python.org/review/20699/diff/13912/Doc/library/io.rst#newcode686
Doc/library/io.rst:686: Write the :term:`bytes-like object` object, *b*,
and return the
Looks like there's an extra 'object' here, but I didn't generate the
docs to check.

http://bugs.python.org/review/20699/


More information about the docs mailing list