From 427c177047b526b5d15859e36b2c86fea477bfff Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Wed, 18 Oct 2023 04:51:01 -0400 Subject: [PATCH] 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. --- git/objects/submodule/base.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/git/objects/submodule/base.py b/git/objects/submodule/base.py index 13d897263..473ebde76 100644 --- a/git/objects/submodule/base.py +++ b/git/objects/submodule/base.py @@ -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, pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy