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

Commit427c177

Browse files
committed
Add missing info in Submodule.remove docstring
This rewords and adds some missing information to the docstring ofSubmodule.remove, for the "method" parameter, discussed in#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.
1 parent6f765a2 commit427c177

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

‎git/objects/submodule/base.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -948,17 +948,16 @@ def remove(
948948
"""Remove this submodule from the repository. This will remove our entry
949949
from the .gitmodules file and the entry in the .git / config file.
950950
951-
:param module: If True, the module checkout we point to will be deleted
952-
as well. If the module is currently on a commit which is not part
953-
of any branch in the remote, if the currently checked out branch
954-
working tree, or untracked files,
955-
is ahead of its tracking branch, if you have modifications in the
951+
:param module: If True, the checked out module we point to will be deleted as
952+
well.If that module is currently on a commit outside any branch in the
953+
remote, or if it is ahead of its tracking branch, or if there are modified
954+
or untracked files in its working tree, then the removal will fail.
956955
In case the removal of the repository fails for these reasons, the
957956
submodule status will not have been altered.
958-
If this submodule has child-moduleson its own, these will be deleted
959-
priorto touching theown module.
957+
If this submodule has child modulesof its own, these will be deleted prior
958+
to touching thedirect submodule.
960959
:param force: Enforces the deletion of the module even though it contains
961-
modifications. This basically enforces a brute -force file system based
960+
modifications. This basically enforces a brute-force file system based
962961
deletion.
963962
:param configuration: if True, the submodule is deleted from the configuration,
964963
otherwise it isn't. Although this should be enabled most of the times,

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp