summaryrefslogtreecommitdiff
path: root/git/cmd.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/cmd.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/cmd.py')
-rw-r--r--git/cmd.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/git/cmd.py b/git/cmd.py
index 9ef1e3a6..134001e2 100644
--- a/git/cmd.py
+++ b/git/cmd.py
@@ -735,6 +735,7 @@ class Git(LazyMixin):
def __getattr__(self, name: str) -> Any:
"""A convenience method as it allows to call the command as if it was
an object.
+
:return: Callable object that will execute call _call_process with your arguments."""
if name[0] == "_":
return LazyMixin.__getattr__(self, name)
@@ -915,7 +916,7 @@ class Git(LazyMixin):
render the repository incapable of accepting changes until the lock is manually
removed.
:param strip_newline_in_stdout:
- Whether to strip the trailing `\n` of the command stdout.
+ Whether to strip the trailing ``\\n`` of the command stdout.
:return:
* str(output) if extended_output = False (Default)
* tuple(int(status), str(stdout), str(stderr)) if extended_output = True
@@ -1384,7 +1385,8 @@ class Git(LazyMixin):
def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]:
"""As get_object_header, but returns object data as well
- :return: (hexsha, type_string, size_as_int,data_string)
+
+ :return: (hexsha, type_string, size_as_int, data_string)
:note: not threadsafe"""
hexsha, typename, size, stream = self.stream_object_data(ref)
data = stream.read(size)