Commit 01cc8e2
committed
Fix unnecessarily long reference in Tree docstrings
There is no advantage to fully qualifying names in the same module
as the entity being documented, but I had accidentally done that.1 parent f83b056 commit 01cc8e2
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -162,7 +162,7 @@ def __delitem__(self, name: str) -> None: | |||
| 162 | 162 | ||
| 163 | 163 | class Tree(IndexObject, git_diff.Diffable, util.Traversable, util.Serializable): | |
| 164 | 164 | R"""Tree objects represent an ordered list of :class:`~git.objects.blob.Blob`\s and | |
| 165 | - other :class:`~git.objects.tree.Tree`\s. | ||
| 165 | + other :class:`Tree`\s. | ||
| 166 | 166 | ||
| 167 | 167 | Tree as a list: | |
| 168 | 168 | ||
@@ -230,8 +230,8 @@ def join(self, file: str) -> IndexObjUnion: | |||
| 230 | 230 | """Find the named object in this tree's contents. | |
| 231 | 231 | ||
| 232 | 232 | :return: | |
| 233 | - :class:`~git.objects.blob.Blob`, :class:`~git.objects.tree.Tree`, | ||
| 234 | - or :class:`~git.objects.submodule.base.Submodule` | ||
| 233 | + :class:`~git.objects.blob.Blob`, :class:`Tree`, or | ||
| 234 | + :class:`~git.objects.submodule.base.Submodule` | ||
| 235 | 235 | ||
| 236 | 236 | :raise KeyError: | |
| 237 | 237 | If the given file or tree does not exist in this tree. | |
0 commit comments