Commit 3813bfb
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
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -124,7 +124,7 @@ def __init__( | |||
| 124 | 124 | the ``url`` parameter. | |
| 125 | 125 | :param parent_commit: See :meth:`set_parent_commit`. | |
| 126 | 126 | :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 | ||
| 128 | 128 | remote repository. | |
| 129 | 129 | """ | |
| 130 | 130 | super().__init__(repo, binsha, mode, path) | |
@@ -1322,7 +1322,7 @@ def branch(self) -> "Head": | |||
| 1322 | 1322 | @property | |
| 1323 | 1323 | def branch_path(self) -> PathLike: | |
| 1324 | 1324 | """ | |
| 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 | ||
| 1326 | 1326 | from the remote and track | |
| 1327 | 1327 | """ | |
| 1328 | 1328 | return self._branch_path | |
0 commit comments