Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

gh-125436: add missing allow_unnamed_section doc; split too long line#125437

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.

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

Already on GitHub?Sign in to your account

Merged
Eclips4 merged 6 commits intopython:mainfromlitlighilit:lit-fix-doc
Nov 5, 2024

Conversation

litlighilit
Copy link
Contributor

@litlighilitlitlighilit commentedOct 14, 2024•
edited by github-actionsbot
Loading

Copy link
Member

@Eclips4Eclips4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Please add aversionchanged section for theallow_unnamed_section parameter.

@bedevere-app
Copy link

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 be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phraseI have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@Eclips4
Copy link
Member

Though, let' not add a newversionchanged section, let's add aversionadded section with a short explanation of whatallow_unnamed_section is doing.

@litlighilit
Copy link
ContributorAuthor

litlighilit commentedOct 14, 2024•
edited
Loading

Many params own their decription below function doc.

So is ConfigParser'sdefault_sectionconverter param.

Screenshot_2024-10-14-17-05-44-337_org.mozilla.firefox-edit.jpg

a short explanation of what allow_unnamed_section is doing.

Shallallow_unnamed_section's decription go here, too?

@Eclips4
Copy link
Member

Shallallow_unnamed_section's decription go here, too?

Yes, it should. After its description there should be aversionadded directive.

@picnixz
Copy link
Member

picnixz commentedOct 14, 2024•
edited
Loading

You may also add theversionadded after the doctests, where the otherversionchanged were put (just be careful to order it by version).

Eclips4 reacted with thumbs up emoji

@litlighilit
Copy link
ContributorAuthor

litlighilit commentedOct 14, 2024•
edited
Loading

Both of desc andversionchanged are done.

See if the added desc forallow_unnamed_section is suitable.

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;
Copy link
Member

@Eclips4Eclips4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks for the changes!
Taking a closer look at the#117273 I've noticed that the classConfigParser inherits from theRawConfigParser and therefore parameterallow_unnamed_section has actually been added to theRawConfigParser class. Therefore, we need to do two things:

  • Update doc forConfigParser (which you have already done!)
  • Update doc forRawConfigParser. Although this class is considered legacy in docs, it would still be useful to update its signature. The section with an explanation whatallow_unnamed_section is doing unnecessary here.

litlighilit reacted with heart emoji
- apply suggestion frompython#125437 (review)- also update for  `versionchanged` for params of RawConfigParser
@litlighilit
Copy link
ContributorAuthor

ping@Eclips4

Copy link
Member

@Eclips4Eclips4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Sorry for waiting@litlighilit! LGTM. Thank you!

@Eclips4Eclips4enabled auto-merge (squash)November 5, 2024 02:34
@Eclips4Eclips4 merged commitd960226 intopython:mainNov 5, 2024
28 of 29 checks passed
@miss-islington-app
Copy link

Thanks@litlighilit for the PR, and@Eclips4 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestNov 5, 2024
… 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 commitd960226)Co-authored-by: lit <litlighilit@foxmail.com>
@bedevere-app
Copy link

GH-126421 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelNov 5, 2024
Eclips4 pushed a commit that referenced this pull requestNov 5, 2024
…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 commitd960226)Co-authored-by: lit <litlighilit@foxmail.com>
picnixz pushed a commit to picnixz/cpython that referenced this pull requestDec 8, 2024
… 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.
ebonnal pushed a commit to ebonnal/cpython that referenced this pull requestJan 12, 2025
… 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.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@vadmiumvadmiumvadmium left review comments

@Eclips4Eclips4Eclips4 approved these changes

Assignees
No one assigned
Labels
docsDocumentation in the Doc dirskip news
Projects
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@litlighilit@Eclips4@picnixz@vadmium
[8]ページ先頭
©2009-2025 Movatter.jp