[Python-checkins] CVS: python/dist/src/Doc/lib libmultifile.tex,1.10,1.11
Fred L. Drake
fdrake@usw-pr-cvs1.sourceforge.net
Thu, 08 Mar 2001 14:46:43 -0800
Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv24820
Modified Files:
libmultifile.tex
Log Message:
Re-order some method descriptions for a more logical grouping.
(Based on reader comment!)
Index: libmultifile.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libmultifile.tex,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** libmultifile.tex 2000/09/30 17:04:40 1.10
--- libmultifile.tex 2001/03/08 22:46:41 1.11
***************
*** 40,56 ****
A \class{MultiFile} instance has the following methods:
- \begin{methoddesc}{push}{str}
- Push a boundary string. When an appropriately decorated version of
- this boundary is found as an input line, it will be interpreted as a
- section-divider or end-marker. All subsequent
- reads will return the empty string to indicate end-of-file, until a
- call to \method{pop()} removes the boundary a or \method{next()} call
- reenables it.
-
- It is possible to push more than one boundary. Encountering the
- most-recently-pushed boundary will return EOF; encountering any other
- boundary will raise an error.
- \end{methoddesc}
-
\begin{methoddesc}{readline}{str}
Read a line. If the line is data (not a section-divider or end-marker
--- 40,43 ----
***************
*** 72,87 ****
\end{methoddesc}
- \begin{methoddesc}{next}{}
- Skip lines to the next section (that is, read lines until a
- section-divider or end-marker has been consumed). Return true if
- there is such a section, false if an end-marker is seen. Re-enable
- the most-recently-pushed boundary.
- \end{methoddesc}
-
- \begin{methoddesc}{pop}{}
- Pop a section boundary. This boundary will no longer be interpreted
- as EOF.
- \end{methoddesc}
-
\begin{methoddesc}{seek}{pos\optional{, whence}}
Seek. Seek indices are relative to the start of the current section.
--- 59,62 ----
***************
*** 94,97 ****
--- 69,79 ----
\end{methoddesc}
+ \begin{methoddesc}{next}{}
+ Skip lines to the next section (that is, read lines until a
+ section-divider or end-marker has been consumed). Return true if
+ there is such a section, false if an end-marker is seen. Re-enable
+ the most-recently-pushed boundary.
+ \end{methoddesc}
+
\begin{methoddesc}{is_data}{str}
Return true if \var{str} is data and false if it might be a section
***************
*** 103,106 ****
--- 85,106 ----
boundary tests; if it always returns false it will merely slow
processing, not cause it to fail.
+ \end{methoddesc}
+
+ \begin{methoddesc}{push}{str}
+ Push a boundary string. When an appropriately decorated version of
+ this boundary is found as an input line, it will be interpreted as a
+ section-divider or end-marker. All subsequent
+ reads will return the empty string to indicate end-of-file, until a
+ call to \method{pop()} removes the boundary a or \method{next()} call
+ reenables it.
+
+ It is possible to push more than one boundary. Encountering the
+ most-recently-pushed boundary will return EOF; encountering any other
+ boundary will raise an error.
+ \end{methoddesc}
+
+ \begin{methoddesc}{pop}{}
+ Pop a section boundary. This boundary will no longer be interpreted
+ as EOF.
\end{methoddesc}