Commit 427c177
committed
Add missing info in Submodule.remove docstring
This rewords and adds some missing information to the docstring of
Submodule.remove, for the "method" 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 the "force" parameter.1 parent 6f765a2 commit 427c177
1 file changed
Lines changed: 7 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -948,17 +948,16 @@ def remove( | |||
| 948 | 948 | """Remove this submodule from the repository. This will remove our entry | |
| 949 | 949 | from the .gitmodules file and the entry in the .git / config file. | |
| 950 | 950 | ||
| 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. | ||
| 956 | 955 | In case the removal of the repository fails for these reasons, the | |
| 957 | 956 | submodule status will not have been altered. | |
| 958 | - If this submodule has child - modules on its own, these will be deleted | ||
| 959 | - prior to touching the own module. | ||
| 957 | + If this submodule has child modules of its own, these will be deleted prior | ||
| 958 | + to touching the direct submodule. | ||
| 960 | 959 | :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 | ||
| 962 | 961 | deletion. | |
| 963 | 962 | :param configuration: if True, the submodule is deleted from the configuration, | |
| 964 | 963 | otherwise it isn't. Although this should be enabled most of the times, | |
0 commit comments