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

Add missing info in Submodule.remove docstring#1714

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

Conversation

EliahKagan
Copy link
Member

@EliahKaganEliahKagan commentedOct 18, 2023
edited
Loading

Fixes#1712

This rewords and adds some missing information to the docstring ofSubmodule.remove, for themethod parameter, discussed in#1712. It uses the second suggestion presented in that issue, formatted in the style of the surrounding docstring (an 88-column wrap).

It also does some other rewording in that docstring, for clarity, at the end of that same section (on themethod parameter), and a small punctuation fix in the section about theforce parameter.

A note on coordination

Please note that, while this is not a behavioral change, I believe an ordinary patch release rather than a "post" release should be made if this is included. In particular, although I discussed doing a "post" release in#1715, a release that includes both this change and the changes from#1715 should be a normal 3.1.39 release. (In contrast, if this modified only files such asREADME.md or documentation indoc/, then a post release would make sense.)

This rewords and adds some missing information to the docstring ofSubmodule.remove, for the "method" parameter, discussed ingitpython-developers#1712.It uses the second suggestion presented in that issue, formattedin the style of the surrounding docstring (an 88-column wrap).It also does some other rewording in that docstring, for clarity,at the end of that same section (on the "method" parameter), and asmall punctuation fix in the section about the "force" parameter.
@Byron
Copy link
Member

Thanks so much for your help, it's much appreciated!

I will happilynot make the next release a "post" release as suggested (afterlooking it up), merely because I have never done it before and am afraid that this breaks anything or anyone downstream 😅.

EliahKagan reacted with thumbs up emoji

@ByronByron merged commita5b2fa5 intogitpython-developers:mainOct 18, 2023
@EliahKagan
Copy link
MemberAuthor

EliahKagan commentedOct 18, 2023
edited
Loading

That makes sense, and as I've just written about in#1716, I think there's another change thatmight make sense to include in 3.1.39[edit: or 3.1.40], if the timing works out.

Otherwise, it, or some alternative to it, could come in with 3.1.40[edit: or 3.1.41] later.

@EliahKaganEliahKagan deleted the docstring-submodule-remove branchOctober 18, 2023 15:41
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Submodule.removemodule parameter doc is unclear or incomplete
2 participants
@EliahKagan@Byron

[8]ページ先頭

©2009-2025 Movatter.jp