]> granicus.if.org Git - python/commitdiff
Update configparser docs for lowercasing rename.
authorGeorg Brandl <georg@python.org>
Wed, 14 May 2008 22:30:31 +0000 (22:30 +0000)
committerGeorg Brandl <georg@python.org>
Wed, 14 May 2008 22:30:31 +0000 (22:30 +0000)
Doc/library/configparser.rst
Doc/library/logging.rst
Doc/library/shlex.rst

index 911f8dcf16ac1864107c15235f457880a462126b..50373fc1483da5b493cc31b5419b2f25a29e7195 100644 (file)
@@ -1,14 +1,20 @@
-
 :mod:`ConfigParser` --- Configuration file parser
 =================================================
 
 .. module:: ConfigParser
+   :synopsis: Old name for the configparser module.
+
+.. module:: configparser
    :synopsis: Configuration file parser.
 .. moduleauthor:: Ken Manheimer <klm@zope.com>
 .. moduleauthor:: Barry Warsaw <bwarsaw@python.org>
 .. moduleauthor:: Eric S. Raymond <esr@thyrsus.com>
 .. sectionauthor:: Christopher G. Petrilli <petrilli@amber.org>
 
+.. note::
+   The :mod:`ConfigParser` module has been renamed to :mod:`configparser` in
+   Python 3.0.  It is importable under both names in Python 2.6 and the rest of
+   the 2.x series.
 
 .. index::
    pair: .ini; file
index 371ece38d95bf4ea7456309212e8a31c67e3d1d0..b2686aa6c2355ece6e0ca95d3288edf88249cb92 100644 (file)
@@ -2240,12 +2240,12 @@ in :mod:`logging` itself) and defining handlers which are declared either in
 
 .. function:: fileConfig(fname[, defaults])
 
-   Reads the logging configuration from a ConfigParser-format file named *fname*.
-   This function can be called several times from an application, allowing an end
-   user the ability to select from various pre-canned configurations (if the
-   developer provides a mechanism to present the choices and load the chosen
-   configuration). Defaults to be passed to ConfigParser can be specified in the
-   *defaults* argument.
+   Reads the logging configuration from a :mod:`configparser`\-format file named
+   *fname*.  This function can be called several times from an application,
+   allowing an end user the ability to select from various pre-canned
+   configurations (if the developer provides a mechanism to present the choices
+   and load the chosen configuration). Defaults to be passed to the ConfigParser
+   can be specified in the *defaults* argument.
 
 
 .. function:: listen([port])
index 0ae77c173a0153ea4c2407dda76450692dfe7fd3..1dfafbd0bac298e6c466b48059bcacb08e32711d 100644 (file)
@@ -63,7 +63,7 @@ The :mod:`shlex` module defines the following class:
 
 .. seealso::
 
-   Module :mod:`ConfigParser`
+   Module :mod:`configparser`
       Parser for configuration files similar to the Windows :file:`.ini` files.