From: Julien Palard <julien@palard.fr>
Date: Wed, 23 Mar 2022 08:35:33 +0000 (+0100)
Subject: [doc] configparser: avoid inline comments. (GH-31247)
X-Git-Tag: v3.11.0a7~152
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3ac4e783e077ffd7b51c6acc1591002974644051;p=thirdparty%2FPython%2Fcpython.git

[doc] configparser: avoid inline comments. (GH-31247)

People are testing those blocs with the default
inline_comment_prefixes of None, leading to a:

configparser.InterpolationSyntaxError: '$' must be followed by '$' or '{', found: '$ sign ($ is the only character that needs to be escaped)'
---

diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 323dd2affc78..72aa20d73d8b 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -347,7 +347,8 @@ from ``get()`` calls.
       my_pictures: %(my_dir)s/Pictures
 
       [Escape]
-      gain: 80%%  # use a %% to escape the % sign (% is the only character that needs to be escaped)
+      # use a %% to escape the % sign (% is the only character that needs to be escaped):
+      gain: 80%%
 
    In the example above, :class:`ConfigParser` with *interpolation* set to
    ``BasicInterpolation()`` would resolve ``%(home_dir)s`` to the value of
@@ -382,7 +383,8 @@ from ``get()`` calls.
       my_pictures: ${my_dir}/Pictures
 
       [Escape]
-      cost: $$80  # use a $$ to escape the $ sign ($ is the only character that needs to be escaped)
+      # use a $$ to escape the $ sign ($ is the only character that needs to be escaped):
+      cost: $$80
 
    Values from other sections can be fetched as well: