Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc for ConfigParser misses allow_unnamed_section=False param #125436

Open
litlighilit opened this issue Oct 14, 2024 · 5 comments
Open

Doc for ConfigParser misses allow_unnamed_section=False param #125436

litlighilit opened this issue Oct 14, 2024 · 5 comments
Labels
3.13 bugs and security fixes 3.14 new features, bugs and security fixes docs Documentation in the Doc dir

Comments

@litlighilit
Copy link
Contributor

litlighilit commented Oct 14, 2024 •
edited by bedevere-app bot
Loading

Currently

doc for configparser.ConfigParser

misses allow_unnamed_section=False param, which is added in #117273

Screenshot_2024-10-14-16-21-01-815_org.mozilla.firefox-edit.jpg

Linked PRs
@litlighilit litlighilit added the docs Documentation in the Doc dir label Oct 14, 2024
@Eclips4 Eclips4 added 3.13 bugs and security fixes 3.14 new features, bugs and security fixes labels Oct 14, 2024
@Eclips4
Copy link
Member

Eclips4 commented Oct 14, 2024

Hello!
Thanks for the report. Would you like to send a PR with fix? :)

@litlighilit
Copy link
Contributor Author

litlighilit commented Oct 14, 2024 •
edited
Loading

Ok, I'm doing

litlighilit added a commit to litlighilit/cpython that referenced this issue Oct 14, 2024
@litlighilit
pythongh-125436: add missing allow_unnamed_section doc
58ffc51
litlighilit added a commit to litlighilit/cpython that referenced this issue Oct 14, 2024
@litlighilit
pythongh-125436: split too long line of ConfigParser doc
4f84f43
@bedevere-app bedevere-app bot mentioned this issue Oct 14, 2024
Open
@litlighilit
Copy link
Contributor Author

litlighilit commented Oct 14, 2024 •
edited
Loading

I suddenly find that 'Changed since 3.13' is missing for ConfigParser allow_unnamed_section, too.

Also decription about "When allow_unnamed_section is True,..." should goes below https://docs.python.org/3/library/configparser.html#configparser.ConfigParser, like any other params

@Eclips4
Copy link
Member

Eclips4 commented Oct 14, 2024

I suddenly find that 'Changed since 3.13' is missing for ConfigParser allow_unnamed_section, too.

Also decription about "When allow_unnamed_section is True,..." should goes below https://docs.python.org/3/library/configparser.html#configparser.ConfigParser, like any other params

Yeah, you're right. Let's only do things related to allow_unnamed_section in #125436 and other improvements in the follow-up PR.

litlighilit added a commit to litlighilit/cpython that referenced this issue Oct 14, 2024
@litlighilit
pythongh-125436: fixup missing desc and verionchanged
b8db50b
@litlighilit
Copy link
Contributor Author

litlighilit commented Oct 14, 2024 •
edited
Loading

Ok.

at least as of now, all commits are about allow_unnamed_section,

though a little far away from the original issue.

litlighilit added a commit to litlighilit/cpython that referenced this issue Oct 15, 2024
@litlighilit
pythongh-125436: add *; apply suggestion from @picnixz
5dea065 
- 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;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
3.13 bugs and security fixes 3.14 new features, bugs and security fixes docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Eclips4 @litlighilit