From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Tue, 10 Sep 2019 13:32:42 +0000 (-0700)
Subject: bpo-21018: added missing documentation about escaping characters for configparser... 
X-Git-Tag: v3.7.5rc1~108
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=122bbf7f8ac2cef4368e3601af593a027dc62ccf;p=thirdparty%2FPython%2Fcpython.git

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

Document how $ and % can be escaped in configparser.
(cherry picked from commit 9a94093189417adddd6b59d6c80cc5544630c8aa)

Co-authored-by: Arun Persaud <arun@nubati.net>
---

diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 68b663ff7f65..6ab858578ba2 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