]> granicus.if.org Git - python/commitdiff
bpo-35838: document optionxform must be idempotent (GH-12656)
authorInada Naoki <songofacandy@gmail.com>
Tue, 2 Apr 2019 09:08:46 +0000 (18:08 +0900)
committerGitHub <noreply@github.com>
Tue, 2 Apr 2019 09:08:46 +0000 (18:08 +0900)
Doc/library/configparser.rst

index 185b4a10ec990e405de9708c18317bf75e041c63..04b52dc7b215315a4758212d87b2366af95ffc49 100644 (file)
@@ -721,6 +721,12 @@ be overridden by subclasses or by attribute assignment.
      >>> list(custom['Section2'].keys())
      ['AnotherKey']
 
+  .. note::
+     The optionxform function transforms option names to a canonical form.
+     This should be an idempotent function: if the name is already in
+     canonical form, it should be returned unchanged.
+
+
 .. attribute:: ConfigParser.SECTCRE
 
   A compiled regular expression used to parse section headers.  The default