Skip to content

Commit cf5cb84

Browse files
committed
Small docstring copyedits
- Slightly improve grammar ("it's" -> "its"). - Add a missing space after a "." (between sentences). - Use more consistent hard wrap in a place where 88 was intended.
1 parent e54277f commit cf5cb84

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

git/objects/submodule/base.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -958,7 +958,7 @@ def move(self, module_path: PathLike, configuration: bool = True, module: bool =
958958
raise
959959
# END handle undo rename
960960

961-
# Auto-rename submodule if it's name was 'default', that is, the checkout directory.
961+
# Auto-rename submodule if its name was 'default', that is, the checkout directory.
962962
if previous_sm_path == self.name:
963963
self.rename(module_checkout_path)
964964

@@ -976,19 +976,19 @@ def remove(
976976
from the .gitmodules file and the entry in the .git/config file.
977977
978978
:param module: If True, the checked out module we point to will be deleted as
979-
well.If that module is currently on a commit outside any branch in the
979+
well. If that module is currently on a commit outside any branch in the
980980
remote, or if it is ahead of its tracking branch, or if there are modified
981-
or untracked files in its working tree, then the removal will fail.
982-
In case the removal of the repository fails for these reasons, the
983-
submodule status will not have been altered.
981+
or untracked files in its working tree, then the removal will fail. In case
982+
the removal of the repository fails for these reasons, the submodule status
983+
will not have been altered.
984984
If this submodule has child modules of its own, these will be deleted prior
985985
to touching the direct submodule.
986986
:param force: Enforces the deletion of the module even though it contains
987987
modifications. This basically enforces a brute-force file system based
988988
deletion.
989989
:param configuration: If True, the submodule is deleted from the configuration,
990-
otherwise it isn't. Although this should be enabled most of the time,
991-
this flag enables you to safely delete the repository of your submodule.
990+
otherwise it isn't. Although this should be enabled most of the time, this
991+
flag enables you to safely delete the repository of your submodule.
992992
:param dry_run: If True, we will not actually do anything, but throw the errors
993993
we would usually throw.
994994
:return: self

0 commit comments

Comments
 (0)
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