[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)'
This commit is contained in:
Julien Palard 2022-03-23 09:35:33 +01:00 committed by GitHub
parent ec8906fb59
commit 3ac4e783e0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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: