diff options
author | Benjamin Peterson <benjamin@python.org> | 2008-04-14 21:30:21 (GMT) |
---|---|---|
committer | Benjamin Peterson <benjamin@python.org> | 2008-04-14 21:30:21 (GMT) |
commit | 9efcc4b3196b9f7c3789468658a1a5017e787534 (patch) | |
tree | c96eb3de70c1f6bc3a2756c65f9e03a4a024f64f | |
parent | e0313f20c0a2e394b8e9606f415316f73c840a16 (diff) | |
download | cpython-9efcc4b3196b9f7c3789468658a1a5017e787534.zip cpython-9efcc4b3196b9f7c3789468658a1a5017e787534.tar.gz cpython-9efcc4b3196b9f7c3789468658a1a5017e787534.tar.bz2 |
Fix problems in the io docs noted by Alexandre Vassalotti
-rw-r--r-- | Doc/library/io.rst | 4 | ||||
-rw-r--r-- | Lib/io.py | 11 |
2 files changed, 6 insertions, 9 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst index f705c30..4fb79b9 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -437,12 +437,12 @@ Buffered Streams .. method:: read1() - In :class:`BytesIO`, this is the same as :meth:`read()`. + In :class:`BytesIO`, this is the same as :meth:`read`. .. method:: truncate([pos]) Truncate the file to at most *pos* bytes. *pos* defaults to the current - stream position, as returned by :meth:`tell()`. + stream position, as returned by :meth:`tell`. .. class:: BufferedReader(raw[, buffer_size]) @@ -1,5 +1,4 @@ -""" -The io module provides the Python interfaces to stream handling. The +"""The io module provides the Python interfaces to stream handling. The builtin open function is defined in this module. At the top of the I/O hierarchy is the abstract base class IOBase. It @@ -78,8 +77,7 @@ class BlockingIOError(IOError): def open(file, mode="r", buffering=None, encoding=None, errors=None, newline=None, closefd=True): - r""" - Open file and return a stream. If the file cannot be opened, an + r"""Open file and return a stream. If the file cannot be opened, an IOError is raised. file is either a string giving the name (and the path if the file @@ -287,8 +285,7 @@ class UnsupportedOperation(ValueError, IOError): class IOBase(metaclass=abc.ABCMeta): - """ - The abstract base class for all I/O classes, acting on streams of + """The abstract base class for all I/O classes, acting on streams of bytes. There is no public constructor. This class provides dummy implementations for many methods that @@ -793,7 +790,7 @@ class BytesIO(BufferedIOBase): return bytes(b) def read1(self, n): - """In BytesIO, this is the same as read. + """This is the same as read. """ return self.read(n) |