Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork966
Add missing info in Submodule.remove docstring#1714
Merged
Byron merged 1 commit intogitpython-developers:mainfromOct 18, 2023
Merged
Add missing info in Submodule.remove docstring#1714Byron merged 1 commit intogitpython-developers:mainfrom
Byron merged 1 commit intogitpython-developers:mainfrom
Conversation
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.
This was referencedOct 18, 2023
Member
Byron commentedOct 18, 2023
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 😅. |
MemberAuthor
EliahKagan commentedOct 18, 2023 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
Fixes#1712
This rewords and adds some missing information to the docstring of
Submodule.remove, for themethodparameter, 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 the
methodparameter), and a small punctuation fix in the section about theforceparameter.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 as
README.mdor documentation indoc/, then a post release would make sense.)