From: Arun Persaud <arun@nubati.net>
Date: Tue, 10 Sep 2019 12:51:09 +0000 (-0700)
Subject: bpo-21018: added missing documentation about escaping characters for configparser... 
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=9a94093189417adddd6b59d6c80cc5544630c8aa;p=python

bpo-21018: added missing documentation about escaping characters for configparser (GH-6137)

Document how $ and % can be escaped in configparser.
---

diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 04b52dc7b2..739477f55f 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -313,6 +313,8 @@ from ``get()`` calls.
       my_dir: %(home_dir)s/lumberjack
       my_pictures: %(my_dir)s/Pictures
 
+      [Escape]
+      gain: 80%%  # use a %% to escape the % sign (% is the only character that needs to be escaped)
 
    In the example above, :class:`ConfigParser` with *interpolation* set to
    ``BasicInterpolation()`` would resolve ``%(home_dir)s`` to the value of
@@ -346,6 +348,9 @@ from ``get()`` calls.
       my_dir: ${home_dir}/lumberjack
       my_pictures: ${my_dir}/Pictures
 
+      [Escape]
+      cost: $$80  # use a $$ to escape the $ sign ($ is the only character that needs to be escaped)
+
    Values from other sections can be fetched as well:
 
    .. code-block:: ini