Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit f0ebbe0

Browse files
committed
Re-order some method descriptions for a more logical grouping.
(Based on reader comment!)
1 parent 9eb4155 commit f0ebbe0

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

Doc/lib/libmultifile.tex

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,6 @@ \subsection{MultiFile Objects \label{MultiFile-objects}}
3939

4040
A \class{MultiFile} instance has the following methods:
4141

42-
\begin{methoddesc}{push}{str}
43-
Push a boundary string. When an appropriately decorated version of
44-
this boundary is found as an input line, it will be interpreted as a
45-
section-divider or end-marker. All subsequent
46-
reads will return the empty string to indicate end-of-file, until a
47-
call to \method{pop()} removes the boundary a or \method{next()} call
48-
reenables it.
49-
50-
It is possible to push more than one boundary. Encountering the
51-
most-recently-pushed boundary will return EOF; encountering any other
52-
boundary will raise an error.
53-
\end{methoddesc}
54-
5542
\begin{methoddesc}{readline}{str}
5643
Read a line. If the line is data (not a section-divider or end-marker
5744
or real EOF) return it. If the line matches the most-recently-stacked
@@ -71,18 +58,6 @@ \subsection{MultiFile Objects \label{MultiFile-objects}}
7158
(multiline) string. Note that this doesn't take a size argument!
7259
\end{methoddesc}
7360

74-
\begin{methoddesc}{next}{}
75-
Skip lines to the next section (that is, read lines until a
76-
section-divider or end-marker has been consumed). Return true if
77-
there is such a section, false if an end-marker is seen. Re-enable
78-
the most-recently-pushed boundary.
79-
\end{methoddesc}
80-
81-
\begin{methoddesc}{pop}{}
82-
Pop a section boundary. This boundary will no longer be interpreted
83-
as EOF.
84-
\end{methoddesc}
85-
8661
\begin{methoddesc}{seek}{pos\optional{, whence}}
8762
Seek. Seek indices are relative to the start of the current section.
8863
The \var{pos} and \var{whence} arguments are interpreted as for a file
@@ -93,6 +68,13 @@ \subsection{MultiFile Objects \label{MultiFile-objects}}
9368
Return the file position relative to the start of the current section.
9469
\end{methoddesc}
9570

71+
\begin{methoddesc}{next}{}
72+
Skip lines to the next section (that is, read lines until a
73+
section-divider or end-marker has been consumed). Return true if
74+
there is such a section, false if an end-marker is seen. Re-enable
75+
the most-recently-pushed boundary.
76+
\end{methoddesc}
77+
9678
\begin{methoddesc}{is_data}{str}
9779
Return true if \var{str} is data and false if it might be a section
9880
boundary. As written, it tests for a prefix other than \code{'-}\code{-'} at
@@ -104,6 +86,24 @@ \subsection{MultiFile Objects \label{MultiFile-objects}}
10486
processing, not cause it to fail.
10587
\end{methoddesc}
10688

89+
\begin{methoddesc}{push}{str}
90+
Push a boundary string. When an appropriately decorated version of
91+
this boundary is found as an input line, it will be interpreted as a
92+
section-divider or end-marker. All subsequent
93+
reads will return the empty string to indicate end-of-file, until a
94+
call to \method{pop()} removes the boundary a or \method{next()} call
95+
reenables it.
96+
97+
It is possible to push more than one boundary. Encountering the
98+
most-recently-pushed boundary will return EOF; encountering any other
99+
boundary will raise an error.
100+
\end{methoddesc}
101+
102+
\begin{methoddesc}{pop}{}
103+
Pop a section boundary. This boundary will no longer be interpreted
104+
as EOF.
105+
\end{methoddesc}
106+
107107
\begin{methoddesc}{section_divider}{str}
108108
Turn a boundary into a section-divider line. By default, this
109109
method prepends \code{'-}\code{-'} (which MIME section boundaries have) but

0 commit comments

Comments
 (0)