Improve stream_object_data and _parse_object_header docstrings

EliahKagan · EliahKagan · commit fc59e5eafde7 · 2024-03-01T20:05:57.000-05:00
This slightly adjusts working and formatting of these methods of
the Git class, for clarity.
diff --git a/git/cmd.py b/git/cmd.py
@@ -1491,7 +1491,9 @@ def _call_process(
     def _parse_object_header(self, header_line: str) -> Tuple[str, str, int]:
         """
         :param header_line:
-            <hex_sha> type_string size_as_int
+            A line of the form::
+
+                <hex_sha> type_string size_as_int
 
         :return:
             (hex_sha, type_string, size_as_int)
@@ -1581,7 +1583,7 @@ def get_object_data(self, ref: str) -> Tuple[str, str, int, bytes]:
         return (hexsha, typename, size, data)
 
     def stream_object_data(self, ref: str) -> Tuple[str, str, int, "Git.CatFileContentStream"]:
-        """Similar to :meth:`get_object_header`, but returns the data as a stream.
+        """Similar to :meth:`get_object_data`, but returns the data as a stream.
 
         :return:
             (hexsha, type_string, size_as_int, stream)
