diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex index 13861935703..92e3f9c6af9 100644 --- a/Doc/lib/libcfgparser.tex +++ b/Doc/lib/libcfgparser.tex @@ -13,11 +13,14 @@ This module defines the class \class{ConfigParser}. \index{Windows ini file} The \class{ConfigParser} class implements a basic configuration file parser language which provides a structure similar to what you would -find on Microsoft Windows INI files. (Beware: this library does \emph{not} -interpret or write the value-type prefixes used in the Windows -Registry extended version of INI syntax.) You can use this to write Python +find on Microsoft Windows INI files. You can use this to write Python programs which can be customized by end users easily. +\begin{notice}[warning] + This library does \emph{not} interpret or write the value-type + prefixes used in the Windows Registry extended version of INI syntax. +\end{notice} + The configuration file consists of sections, led by a \samp{[section]} header and followed by \samp{name: value} entries, with continuations in the style of \rfc{822}; \samp{name=value} is @@ -95,6 +98,11 @@ Exception raised when string interpolation cannot be completed because the number of iterations exceeds \constant{MAX_INTERPOLATION_DEPTH}. \end{excdesc} +\begin{excdesc}{InterpolationSyntaxError} +Exception raised when the source text into which substitutions are +made does not conform to the required syntax. +\end{excdesc} + \begin{excdesc}{MissingSectionHeaderError} Exception raised when attempting to parse a file which has no section headers.