Expand what is included in the API Reference by EliahKagan · Pull Request #1855 · gitpython-developers/GitPython

Expand Up @@ -389,7 +389,9 @@ def __setstate__(self, d: Dict[str, Any]) -> None:
@classmethod def refresh(cls, path: Union[None, PathLike] = None) -> bool: """This gets called by the refresh function (see the top level ``__init__``). """Update information about the git executable :class:`Git` objects will use.
Called by the :func:`git.refresh` function in the top level ``__init__``.
:param path: Optional path to the git executable. If not absolute, it is resolved Expand Down Expand Up @@ -1486,7 +1488,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) Expand Down Expand Up @@ -1576,7 +1580,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) Expand Down