summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2010-03-12 22:45:38 (GMT)
committerEzio Melotti <ezio.melotti@gmail.com>2010-03-12 22:45:38 (GMT)
commit6540a82a40d3a8da418318b9e8a6d090f35a5a92 (patch)
tree98c8f0571fb466f78463b14b9e6c81b3f05630c6 /Doc
parent9920437ac04c9375eee2e7a2a42d9778c1be681c (diff)
downloadcpython-6540a82a40d3a8da418318b9e8a6d090f35a5a92.zip
cpython-6540a82a40d3a8da418318b9e8a6d090f35a5a92.tar.gz
cpython-6540a82a40d3a8da418318b9e8a6d090f35a5a92.tar.bz2
#8057: fix strings -> byte strings
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/bz2.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/Doc/library/bz2.rst b/Doc/library/bz2.rst
index a2272e6..b3a3215 100644
--- a/Doc/library/bz2.rst
+++ b/Doc/library/bz2.rst
@@ -73,15 +73,16 @@ Handling of compressed files is offered by the :class:`BZ2File` class.
.. method:: read([size])
- Read at most *size* uncompressed bytes, returned as a string. If the
+ Read at most *size* uncompressed bytes, returned as a byte string. If the
*size* argument is negative or omitted, read until EOF is reached.
.. method:: readline([size])
- Return the next line from the file, as a string, retaining newline. A
- non-negative *size* argument limits the maximum number of bytes to return
- (an incomplete line may be returned then). Return an empty string at EOF.
+ Return the next line from the file, as a byte string, retaining newline.
+ A non-negative *size* argument limits the maximum number of bytes to
+ return (an incomplete line may be returned then). Return an empty byte
+ string at EOF.
.. method:: readlines([size])
@@ -111,15 +112,16 @@ Handling of compressed files is offered by the :class:`BZ2File` class.
.. method:: write(data)
- Write string *data* to file. Note that due to buffering, :meth:`close` may
- be needed before the file on disk reflects the data written.
+ Write the byte string *data* to file. Note that due to buffering,
+ :meth:`close` may be needed before the file on disk reflects the data
+ written.
- .. method:: writelines(sequence_of_strings)
+ .. method:: writelines(sequence_of_byte_strings)
- Write the sequence of strings to the file. Note that newlines are not
- added. The sequence can be any iterable object producing strings. This is
- equivalent to calling write() for each string.
+ Write the sequence of byte strings to the file. Note that newlines are not
+ added. The sequence can be any iterable object producing byte strings.
+ This is equivalent to calling write() for each byte string.
Sequential (de)compression