diff options
author | Stephan Creutz <stephan.cr@gmx.de> | 2022-12-29 14:50:43 +0100 |
---|---|---|
committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2022-12-29 21:54:43 +0100 |
commit | 44636240a08bba4a13355a5a23543d537ff15576 (patch) | |
tree | 58b8ffefce53940b18fd1afd11c590321758e0c5 /git/objects/tree.py | |
parent | 141cd651e459bff8919798b3ccf03dfa167757f6 (diff) | |
download | gitpython-44636240a08bba4a13355a5a23543d537ff15576.tar.gz |
Fix Sphinx rendering errors
These errors are mostly fixed by either adding blank lines or single
spaces for Sphinx documentation key words.
The commit solely includes documentation changes, no functional
changes.
Diffstat (limited to 'git/objects/tree.py')
-rw-r--r-- | git/objects/tree.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/git/objects/tree.py b/git/objects/tree.py index b72e88c4..a9b491e2 100644 --- a/git/objects/tree.py +++ b/git/objects/tree.py @@ -128,6 +128,7 @@ class TreeModifier(object): """Call this method once you are done modifying the tree information. It may be called several times, but be aware that each call will cause a sort operation + :return self:""" merge_sort(self._cache, git_cmp) return self @@ -175,6 +176,7 @@ class TreeModifier(object): """Add the given item to the tree, its correctness is assumed, which puts the caller into responsibility to assure the input is correct. For more information on the parameters, see ``add`` + :param binsha: 20 byte binary sha""" assert isinstance(binsha, bytes) and isinstance(mode, int) and isinstance(name, str) tree_cache = (binsha, mode, name) @@ -259,8 +261,8 @@ class Tree(IndexObject, git_diff.Diffable, util.Traversable, util.Serializable): def join(self, file: str) -> IndexObjUnion: """Find the named object in this tree's contents - :return: ``git.Blob`` or ``git.Tree`` or ``git.Submodule`` + :return: ``git.Blob`` or ``git.Tree`` or ``git.Submodule`` :raise KeyError: if given file or tree does not exist in tree""" msg = "Blob or Tree named %r not found" if "/" in file: |