summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorInada Naoki <songofacandy@gmail.com>2019-04-02 18:08:46 +0900
committerGitHub <noreply@github.com>2019-04-02 18:08:46 +0900
commit04694a306b8f4ab54ef5fc4ba673c26fa53b0ac1 (patch)
tree112f66ca69d1f33d7d1a05c680781b75909e10d2
parente6a0e804bfad4a5ef03c04d0e3d9a94472966f9a (diff)
downloadcpython-git-04694a306b8f4ab54ef5fc4ba673c26fa53b0ac1.tar.gz
bpo-35838: document optionxform must be idempotent (GH-12656)
-rw-r--r--Doc/library/configparser.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 185b4a10ec..04b52dc7b2 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -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