diff options
| author | Jürgen Gmach <juergen.gmach@googlemail.com> | 2021-05-18 16:11:23 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-18 16:11:23 (GMT) |
| commit | 02ee8191263848f8c8999f72286148946b83e5c9 (patch) | |
| tree | 085154e904b82f135e48cb8b7a991d2115e22e53 /Doc/library | |
| parent | 115dea9e2602b96b63390f00cc880e90c433efa2 (diff) | |
| download | cpython-02ee8191263848f8c8999f72286148946b83e5c9.zip cpython-02ee8191263848f8c8999f72286148946b83e5c9.tar.gz cpython-02ee8191263848f8c8999f72286148946b83e5c9.tar.bz2 | |
bpo-41963: document that ConfigParser strips off comments (GH-26197)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Laura Gutierrez Funderburk <58710704+lgfunderburk@users.noreply.github.com>
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/configparser.rst | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst index 646e8a3..b0c2a2c 100644 --- a/Doc/library/configparser.rst +++ b/Doc/library/configparser.rst @@ -1153,6 +1153,13 @@ ConfigParser Objects *space_around_delimiters* is true, delimiters between keys and values are surrounded by spaces. + .. note:: + + Comments in the original configuration file are not preserved when + writing the configuration back. + What is considered a comment, depends on the given values for + *comment_prefix* and *inline_comment_prefix*. + .. method:: remove_option(section, option) |