summaryrefslogtreecommitdiff
path: root/git/objects/fun.py
diff options
context:
space:
mode:
authorStephan Creutz <stephan.cr@gmx.de>2022-12-29 14:50:43 +0100
committerSebastian Thiel <sebastian.thiel@icloud.com>2022-12-29 21:54:43 +0100
commit44636240a08bba4a13355a5a23543d537ff15576 (patch)
tree58b8ffefce53940b18fd1afd11c590321758e0c5 /git/objects/fun.py
parent141cd651e459bff8919798b3ccf03dfa167757f6 (diff)
downloadgitpython-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/fun.py')
-rw-r--r--git/objects/fun.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/git/objects/fun.py b/git/objects/fun.py
index 001e10e4..e91403a8 100644
--- a/git/objects/fun.py
+++ b/git/objects/fun.py
@@ -37,6 +37,7 @@ __all__ = (
def tree_to_stream(entries: Sequence[EntryTup], write: Callable[["ReadableBuffer"], Union[int, None]]) -> None:
"""Write the give list of entries into a stream using its write method
+
:param entries: **sorted** list of tuples with (binsha, mode, name)
:param write: write method which takes a data string"""
ord_zero = ord("0")
@@ -68,6 +69,7 @@ def tree_to_stream(entries: Sequence[EntryTup], write: Callable[["ReadableBuffer
def tree_entries_from_data(data: bytes) -> List[EntryTup]:
"""Reads the binary representation of a tree and returns tuples of Tree items
+
:param data: data block with tree data (as bytes)
:return: list(tuple(binsha, mode, tree_relative_path), ...)"""
ord_zero = ord("0")