[New-bugs-announce] [issue27824] update ConfigParser docs regarding in-line comments

[Joshua Haas]

New submission from Joshua Haas:

Originally reported at http://bugs.python.org/issue27762 as a behavior bug but was determined to be won't fix. Thus I think this needs to be mentioned in the documentation at https://docs.python.org/2/library/configparser.html

I propose that directly after the following:

"(For backwards compatibility, only ; starts an inline comment, while # does not.)"

be added:

"Inline comments will not be recognised in lines that contain ; before the comment itself. To ensure that inline comments work as expected, do not use ; in config values."

----------
assignee: docs at python
components: Documentation
messages: 273306
nosy: docs at python, jahschwa
priority: normal
severity: normal
status: open
title: update ConfigParser docs regarding in-line comments
type: enhancement
versions: Python 2.7

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue27824>
_______________________________________