Skip to content

Commit

Permalink
Add missing info in Submodule.remove docstring
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
EliahKagan committed Oct 18, 2023
1 parent 6f765a2 commit 427c177
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions git/objects/submodule/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -948,17 +948,16 @@ def remove(
"""Remove this submodule from the repository. This will remove our entry
from the .gitmodules file and the entry in the .git / config file.
:param module: If True, the module checkout we point to will be deleted
as well. If the module is currently on a commit which is not part
of any branch in the remote, if the currently checked out branch
working tree, or untracked files,
is ahead of its tracking branch, if you have modifications in the
:param module: If True, the checked out module we point to will be deleted as
well.If that module is currently on a commit outside any branch in the
remote, or if it is ahead of its tracking branch, or if there are modified
or untracked files in its working tree, then the removal will fail.
In case the removal of the repository fails for these reasons, the
submodule status will not have been altered.
If this submodule has child - modules on its own, these will be deleted
prior to touching the own module.
If this submodule has child modules of its own, these will be deleted prior
to touching the direct submodule.
:param force: Enforces the deletion of the module even though it contains
modifications. This basically enforces a brute - force file system based
modifications. This basically enforces a brute-force file system based
deletion.
:param configuration: if True, the submodule is deleted from the configuration,
otherwise it isn't. Although this should be enabled most of the times,
Expand Down

0 comments on commit 427c177

Please sign in to comment.