Skip to content

Commit 3813bfb

Browse files
committed
Clarify Submodule.branch_path documentation
This changes "Full (relative) path" to "Complete relative path" in the wording used to describe the branch_path initializer parameter and property of the Submodule class. This is to prevent confusion, since "full path" means something like "absolute path" (and is now used as such in error messages introduced since these docstrings were last edited).
1 parent ca32c22 commit 3813bfb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ def __init__(
124124
the ``url`` parameter.
125125
:param parent_commit: See :meth:`set_parent_commit`.
126126
:param url: The URL to the remote repository which is the submodule.
127-
:param branch_path: Full (relative) path to ref to checkout when cloning the
127+
:param branch_path: Complete relative path to ref to checkout when cloning the
128128
remote repository.
129129
"""
130130
super().__init__(repo, binsha, mode, path)
@@ -1322,7 +1322,7 @@ def branch(self) -> "Head":
13221322
@property
13231323
def branch_path(self) -> PathLike:
13241324
"""
1325-
:return: Full (relative) path as string to the branch we would checkout
1325+
:return: Complete relative path as string to the branch we would checkout
13261326
from the remote and track
13271327
"""
13281328
return self._branch_path

0 commit comments

Comments
 (0)