From: Eric S. Raymond Date: Fri, 27 Dec 2002 20:05:36 +0000 (+0000) Subject: Added a useful warning to the documentation. X-Git-Tag: v2.3c1~2862 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=56b3184e89560c2bbaed40239dc8ac16f50828c8;p=thirdparty%2FPython%2Fcpython.git Added a useful warning to the documentation. --- diff --git a/Doc/lib/libcfgparser.tex b/Doc/lib/libcfgparser.tex index 0ad9d61db49f..138619357034 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.