diff Doc/lib/libcfgparser.tex @ 26908:bcaca36a583c legacy-trunk

- re-mark ESR's warning about extended registry syntax - document InterpolationSyntaxError
author Fred Drake <fdrake@acm.org>
date Mon, 30 Dec 2002 23:50:19 +0000
parents 178844988812
children 6e541a72af1a
line wrap: on
line diff
--- a/Doc/lib/libcfgparser.tex	Mon Dec 30 23:38:47 2002 +0000
+++ b/Doc/lib/libcfgparser.tex	Mon Dec 30 23:50:19 2002 +0000
@@ -13,11 +13,14 @@
 \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 @@
 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.