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>
This commit is contained in:
Jürgen Gmach 2021-05-18 18:11:23 +02:00 committed by GitHub
parent 115dea9e26
commit 02ee819126
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 1 deletions

View file

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