summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric S. Raymond <esr@thyrsus.com>2002-12-27 20:05:36 (GMT)
committerEric S. Raymond <esr@thyrsus.com>2002-12-27 20:05:36 (GMT)
commit56b3184e89560c2bbaed40239dc8ac16f50828c8 (patch)
tree9348fea2eb6be6327c56aeed35872d3e1df31ab1
parent33e94437ca0a3dfa27869c2cb170d2e3cbfa1381 (diff)
downloadcpython-56b3184e89560c2bbaed40239dc8ac16f50828c8.zip
cpython-56b3184e89560c2bbaed40239dc8ac16f50828c8.tar.gz
cpython-56b3184e89560c2bbaed40239dc8ac16f50828c8.tar.bz2
Added a useful warning to the documentation.
-rw-r--r--Doc/lib/libcfgparser.tex6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex
index 0ad9d61..1386193 100644
--- a/Doc/lib/libcfgparser.tex
+++ b/Doc/lib/libcfgparser.tex
@@ -13,10 +13,12 @@ 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. You can use this to write Python
+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
programs which can be customized by end users easily.
-The configuration file consists of sections, lead by a
+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
also accepted. Note that leading whitespace is removed from values.