[issue21018] [patch] added missing documentation about escaping characters for configparser
New submission from Arun Persaud: Couldn't find how to escape % and $ in the documentation, so I thought I add a short patch. ---------- assignee: docs@python components: Documentation files: mywork.patch keywords: patch messages: 214442 nosy: Arun.Persaud, docs@python priority: normal severity: normal status: open title: [patch] added missing documentation about escaping characters for configparser type: enhancement Added file: http://bugs.python.org/file34562/mywork.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Changes by R. David Murray <rdmurray@bitdance.com>: ---------- nosy: +lukasz.langa _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Mark Lawrence added the comment: LGTM so can we have a formal patch review please, thanks. ---------- nosy: +BreamoreBoy versions: +Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Berker Peksag added the comment: Thanks for the patch. Two things: * We want to keep docstrings short so could you please revert the changes in Lib/configparser.py? * It would be better to just add an example of escaping these characters in the "Interpolation of values" section (preferably with a short comment.) ---------- nosy: +berker.peksag stage: -> patch review versions: +Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Changes by Mark Lawrence <breamoreboy@yahoo.co.uk>: ---------- nosy: -BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Arun Persaud added the comment: updated the patch, let me know if it needs additional changes. ---------- Added file: http://bugs.python.org/file44598/escape.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21018> _______________________________________
Cheryl Sabella <chekat2@gmail.com> added the comment: @Arun.Persaud, would you be interested in converting your patch to a Github pull request? ---------- nosy: +csabella versions: +Python 3.7, Python 3.8 -Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Arun Persaud <arun.persaud@gmail.com> added the comment:
@Arun.Persaud, would you be interested in converting your patch to a Github pull request?
sure, I'll give it a try. Arun ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Arun Persaud <arun.persaud@gmail.com> added the comment: created github PR #6137. Hope everything is in the correct format. Arun ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- pull_requests: +5894 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Change by Cheryl Sabella <cheryl.sabella@gmail.com>: ---------- versions: -Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: New changeset 9a94093189417adddd6b59d6c80cc5544630c8aa by Julien Palard (Arun Persaud) in branch 'master': bpo-21018: added missing documentation about escaping characters for configparser (GH-6137) https://github.com/python/cpython/commit/9a94093189417adddd6b59d6c80cc554463... ---------- nosy: +mdk _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +15491 pull_request: https://github.com/python/cpython/pull/15845 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +15492 pull_request: https://github.com/python/cpython/pull/15846 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: Thanks! ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: New changeset 122bbf7f8ac2cef4368e3601af593a027dc62ccf by Julien Palard (Miss Islington (bot)) in branch '3.7': bpo-21018: added missing documentation about escaping characters for configparser (GH-6137) (GH-15845) https://github.com/python/cpython/commit/122bbf7f8ac2cef4368e3601af593a027dc... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
Julien Palard <julien+python@palard.fr> added the comment: New changeset 5cf8155bbd2c65572295b26e96c221763b3322f0 by Julien Palard (Miss Islington (bot)) in branch '3.8': bpo-21018: added missing documentation about escaping characters for configparser (GH-6137) (GH-15846) https://github.com/python/cpython/commit/5cf8155bbd2c65572295b26e96c221763b3... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21018> _______________________________________
participants (8)
-
Arun Persaud -
Berker Peksag
-
Cheryl Sabella
-
Julien Palard
-
Mark Lawrence
-
miss-islington
-
R. David Murray
-
Roundup Robot