]> granicus.if.org Git - python/commitdiff
Added a useful warning to the documentation.
authorEric S. Raymond <esr@thyrsus.com>
Fri, 27 Dec 2002 20:05:36 +0000 (20:05 +0000)
committerEric S. Raymond <esr@thyrsus.com>
Fri, 27 Dec 2002 20:05:36 +0000 (20:05 +0000)
Doc/lib/libcfgparser.tex

index 0ad9d61db49fef46131554180138ba06b827e5d0..138619357034a980f98426582d6919c109710c69 100644 (file)
@@ -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.