Skip to content

Commit ffeb7e7

Browse files
committed
More docstring revisions in git.objects.submodule.base
1 parent e166a0a commit ffeb7e7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Diff for: git/objects/submodule/base.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ def _set_cache_(self, attr: str) -> None:
172172

173173
@classmethod
174174
def _get_intermediate_items(cls, item: "Submodule") -> IterableList["Submodule"]:
175-
""":return: all the submodules of our module repository"""
175+
""":return: All the submodules of our module repository"""
176176
try:
177177
return cls.list_items(item.module())
178178
except InvalidGitRepositoryError:
@@ -326,7 +326,7 @@ def _clone_repo(
326326
Allow unsafe options to be used, like ``--upload-pack``.
327327
328328
:param kwargs:
329-
Additional arguments given to ``git clone``
329+
Additional arguments given to ``git clone``.
330330
"""
331331
module_abspath = cls._module_abspath(repo, path, name)
332332
module_checkout_path = module_abspath
@@ -351,7 +351,7 @@ def _clone_repo(
351351

352352
@classmethod
353353
def _to_relative_path(cls, parent_repo: "Repo", path: PathLike) -> PathLike:
354-
""":return: a path guaranteed to be relative to the given parent repository
354+
""":return: A path guaranteed to be relative to the given parent repository
355355
356356
:raise ValueError:
357357
If path is not contained in the parent repository's working tree.
@@ -642,7 +642,7 @@ def update(
642642
If ``True``, the submodule's sha will be ignored during checkout. Instead,
643643
the remote will be fetched, and the local tracking branch updated. This only
644644
works if we have a local tracking branch, which is the case if the remote
645-
repository had a master branch, or of the ``branch`` option was specified
645+
repository had a master branch, or if the ``branch`` option was specified
646646
for this submodule and the branch existed remotely.
647647
648648
:param progress:
@@ -1309,7 +1309,7 @@ def config_writer(
13091309
repository.
13101310
13111311
:param write:
1312-
If True, the index will be written each time a configuration value changes.
1312+
If ``True``, the index will be written each time a configuration value changes.
13131313
13141314
:note:
13151315
The parameters allow for a more efficient writing of the index, as you can

0 commit comments

Comments
 (0)