Merged revisions 70171,70183,70290,70292,70315,70438,70464 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r70171 | facundo.batista | 2009-03-04 22:18:17 +0100 (Mi, 04 Mär 2009) | 3 lines
Fixed a typo.
........
r70183 | benjamin.peterson | 2009-03-05 01:17:57 +0100 (Do, 05 Mär 2009) | 1 line
add example
........
r70290 | raymond.hettinger | 2009-03-10 02:07:30 +0100 (Di, 10 Mär 2009) | 1 line
Update url for the spec.
........
r70292 | raymond.hettinger | 2009-03-10 05:40:24 +0100 (Di, 10 Mär 2009) | 1 line
Clarify the meaning of normal and subnormal.
........
r70315 | raymond.hettinger | 2009-03-12 01:25:03 +0100 (Do, 12 Mär 2009) | 1 line
Add reference to solution for a commonly asked question.
........
r70438 | benjamin.peterson | 2009-03-17 21:29:51 +0100 (Di, 17 Mär 2009) | 1 line
I thought this was begging for an example
........
r70464 | benjamin.peterson | 2009-03-18 21:58:09 +0100 (Mi, 18 Mär 2009) | 1 line
a much better example
........
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index d716e97..55f23b9 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -603,6 +603,14 @@
its :meth:`next` method; if the value returned is equal to *sentinel*,
:exc:`StopIteration` will be raised, otherwise the value will be returned.
+ One useful application of the second form of :func:`iter` is to read lines of
+ a file until a certain line is reached. The following example reads a file
+ until ``"STOP"`` is reached: ::
+
+ with open("mydata.txt") as fp:
+ for line in iter(fp.readline, "STOP"):
+ process_line(line)
+
.. versionadded:: 2.2