]> granicus.if.org Git - python/commitdiff
#7188: fix optionxform() docs.
authorGeorg Brandl <georg@python.org>
Fri, 23 Oct 2009 08:14:44 +0000 (08:14 +0000)
committerGeorg Brandl <georg@python.org>
Fri, 23 Oct 2009 08:14:44 +0000 (08:14 +0000)
Doc/library/configparser.rst

index ef27524ba2abdbb4301d2f2c67c251d2be2e08ab..1af14cccc091515e05a0f78f0cbfbfe74b90b8ea 100644 (file)
@@ -334,12 +334,20 @@ RawConfigParser Objects
 
 .. method:: RawConfigParser.optionxform(option)
 
-   Transforms the option name *option* as found in an input file or as passed in by
-   client code to the form that should be used in the internal structures.  The
-   default implementation returns a lower-case version of *option*; subclasses may
-   override this or client code can set an attribute of this name on instances to
-   affect this behavior.  Setting this to :func:`str`, for example, would make
-   option names case sensitive.
+   Transforms the option name *option* as found in an input file or as passed in
+   by client code to the form that should be used in the internal structures.
+   The default implementation returns a lower-case version of *option*;
+   subclasses may override this or client code can set an attribute of this name
+   on instances to affect this behavior.
+
+   You don't necessarily need to subclass a ConfigParser to use this method, you
+   can also re-set it on an instance, to a function that takes a string
+   argument.  Setting it to ``str``, for example, would make option names case
+   sensitive::
+
+      cfgparser = ConfigParser()
+      ...
+      cfgparser.optionxform = str
 
 
 .. _configparser-objects: