gh-125436: add missing allow_unnamed_section doc; split too long line #125437
Conversation
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would 8000 be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
|
Though, let' not add a new |
|
Many params own their decription below function doc. So is ConfigParser's
Shall |
Yes, it should. After its description there should be a |
|
You may also add the |
|
Both of desc and See if the added desc for I've seen the CI failure but not sure what's up. |
- add space in ref before `<` char of URL to fix compile error; - add `*` to mark keywords (fixup) of ConfigParser; - simpify desc for `allow_unnamed_section` param;
There was a problem hiding this comment.
Thanks for the changes!
Taking a closer look at the #117273 I've noticed that the class ConfigParser inherits from the RawConfigParser and therefore parameter allow_unnamed_section has actually been added to the RawConfigParser class. Therefore, we need to do two things:
- Update doc for
ConfigParser(which you have already done!) - Update doc for
RawConfigParser. Although this class is considered legacy in docs, it would still be useful to update its signature. The section with an explanation whatallow_unnamed_sectionis doing unnecessary here.
- apply suggestion from python#125437 (review) - also update for `versionchanged` for params of RawConfigParser
|
ping @Eclips4 |
|
Thanks @litlighilit for the PR, and @Eclips4 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
… to ``ConfigParser`` documentation (pythonGH-125437) Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` doc, as well as to it's parent ``RawConfigParser``. Split too long line on ``ConfigParser`` signature. Add some sections about when some of ``RawConfigParser`` parameters were added. (cherry picked from commit d960226) Co-authored-by: lit <litlighilit@foxmail.com>
|
GH-126421 is a backport of this pull request to the 3.13 branch. |
…r to ``ConfigParser`` documentation (GH-125437) (#126421) gh-125436: Doc: Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` documentation (GH-125437) Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` doc, as well as to it's parent ``RawConfigParser``. Split too long line on ``ConfigParser`` signature. Add some sections about when some of ``RawConfigParser`` parameters were added. (cherry picked from commit d960226) Co-authored-by: lit <litlighilit@foxmail.com>
… to ``ConfigParser`` documentation (python#125437) Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` doc, as well as to it's parent ``RawConfigParser``. Split too long line on ``ConfigParser`` signature. Add some sections about when some of ``RawConfigParser`` parameters were added.
… to ``ConfigParser`` documentation (python#125437) Add missing ``allow_unnamed_section`` parameter to ``ConfigParser`` doc, as well as to it's parent ``RawConfigParser``. Split too long line on ``ConfigParser`` signature. Add some sections about when some of ``RawConfigParser`` parameters were added.
allow_unnamed_section=Falseparam #125436📚 Documentation preview 📚: https://cpython-previews--125437.org.readthedocs.build/