summaryrefslogtreecommitdiffstats
path: root/Doc/lib/libcfgparser.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2002-12-30 23:50:19 (GMT)
committerFred Drake <fdrake@acm.org>2002-12-30 23:50:19 (GMT)
commit81e4aa70541c1640d186b4f43999ad8c2679678e (patch)
tree1792227129ce24f11ae2639d70917b8407f1b7a6 /Doc/lib/libcfgparser.tex
parentce1d944b6b3c51bfb6505652c678aaef99c36d50 (diff)
downloadcpython-81e4aa70541c1640d186b4f43999ad8c2679678e.zip
cpython-81e4aa70541c1640d186b4f43999ad8c2679678e.tar.gz
cpython-81e4aa70541c1640d186b4f43999ad8c2679678e.tar.bz2
- re-mark ESR's warning about extended registry syntax
- document InterpolationSyntaxError
Diffstat (limited to 'Doc/lib/libcfgparser.tex')
-rw-r--r--Doc/lib/libcfgparser.tex14
1 files changed, 11 insertions, 3 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index 1386193..92e3f9c 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.