mirror of https://github.com/python/cpython
Fix synopsis for multifile.
This commit is contained in:
parent
446f033e23
commit
d795c5cbd1
|
@ -1,8 +1,9 @@
|
||||||
% Documentation by ESR
|
% Documentation by ESR
|
||||||
\section{Standard Module \module{multifile}}
|
\section{Standard Module \module{multifile}}
|
||||||
\declaremodule[multifile]{standard}{multiFile}
|
\declaremodule{standard}{multifile}
|
||||||
|
|
||||||
\modulesynopsis{None}
|
\modulesynopsis{Support for reading files which contain distinct
|
||||||
|
parts, such as some MIME data.}
|
||||||
|
|
||||||
|
|
||||||
The \class{MultiFile} object enables you to treat sections of a text
|
The \class{MultiFile} object enables you to treat sections of a text
|
||||||
|
@ -32,8 +33,8 @@ end-markers. MultiFile is designed to support parsing of
|
||||||
messages that may have multiple nested message parts, each with its
|
messages that may have multiple nested message parts, each with its
|
||||||
own pattern for section-divider and end-marker lines.
|
own pattern for section-divider and end-marker lines.
|
||||||
|
|
||||||
\subsection{MultiFile Objects}
|
|
||||||
\label{MultiFile-objects}
|
\subsection{MultiFile Objects \label{MultiFile-objects}}
|
||||||
|
|
||||||
A \class{MultiFile} instance has the following methods:
|
A \class{MultiFile} instance has the following methods:
|
||||||
|
|
||||||
|
@ -129,8 +130,7 @@ True if the last end-of-file was for an end-of-message marker.
|
||||||
\end{memberdesc}
|
\end{memberdesc}
|
||||||
|
|
||||||
|
|
||||||
\subsection{\class{Multifile} Example}
|
\subsection{\class{MultiFile} Example \label{multifile-example}}
|
||||||
\label{multifile-example}
|
|
||||||
|
|
||||||
% This is almost unreadable; should be re-written when someone gets time.
|
% This is almost unreadable; should be re-written when someone gets time.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue