mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 12:52:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

file.next() doc refers to itself

Browse source
This commit is contained in:
Sandro Tosi 2012-01-17 18:57:30 +01:00
parent 03c6110b21
commit 25e76bdb69
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
Doc/library/stdtypes.rst
View file

@ -2372,12 +2372,12 @@ Files have the following methods:
A file object is its own iterator, for example ``iter(f)`` returns *f* (unless A file object is its own iterator, for example ``iter(f)`` returns *f* (unless
*f* is closed). When a file is used as an iterator, typically in a *f* is closed). When a file is used as an iterator, typically in a
:keyword:`for` loop (for example, ``for line in f: print line``), the :keyword:`for` loop (for example, ``for line in f: print line``), the
:meth:`next` method is called repeatedly. This method returns the next input :meth:`~file.next` method is called repeatedly. This method returns the next input
line, or raises :exc:`StopIteration` when EOF is hit when the file is open for line, or raises :exc:`StopIteration` when EOF is hit when the file is open for
reading (behavior is undefined when the file is open for writing). In order to reading (behavior is undefined when the file is open for writing). In order to
make a :keyword:`for` loop the most efficient way of looping over the lines of a make a :keyword:`for` loop the most efficient way of looping over the lines of a
file (a very common operation), the :meth:`next` method uses a hidden read-ahead file (a very common operation), the :meth:`~file.next` method uses a hidden read-ahead
buffer. As a consequence of using a read-ahead buffer, combining :meth:`next` buffer. As a consequence of using a read-ahead buffer, combining :meth:`~file.next`
with other file methods (like :meth:`readline`) does not work right. However, with other file methods (like :meth:`readline`) does not work right. However,
using :meth:`seek` to reposition the file to an absolute position will flush the using :meth:`seek` to reposition the file to an absolute position will flush the
read-ahead buffer. read-ahead buffer.