[Python-checkins] [doc] configparser: avoid inline comments. (GH-31247)
JulienPalard
webhook-mailer at python.org
Wed Mar 23 04:35:41 EDT 2022
https://github.com/python/cpython/commit/3ac4e783e077ffd7b51c6acc1591002974644051
commit: 3ac4e783e077ffd7b51c6acc1591002974644051
branch: main
author: Julien Palard <julien at palard.fr>
committer: JulienPalard <julien at palard.fr>
date: 2022-03-23T09:35:33+01:00
summary:
[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)'
files:
M Doc/library/configparser.rst
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 323dd2affc78f..72aa20d73d8bd 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:
More information about the Python-checkins
mailing list