From dc0205296b082b303c726d93c019e7e20fdc687b Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Fri, 23 Oct 2009 08:14:44 +0000 Subject: [PATCH] #7188: fix optionxform() docs. --- Doc/library/configparser.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index ef27524ba2a..1af14cccc09 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -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: