Add missing info in Submodule.remove docstring #1714
Merged
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.
Fixes #1712
This rewords and adds some missing information to the docstring of
Submodule.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 the
method
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 as
README.md
or documentation indoc/
, then a post release would make sense.)