Fix _index_from_*_format docstrings (proc reading)

EliahKagan · EliahKagan · commit 42b8a1ca6b46 · 2023-10-18T11:45:15.000-04:00
In the git.diff.Diff class, the _index_from_patch_format and _index_from_raw_format methods' docstrings had still described them as reading from streams, even though they have instead read from processes (and taken "proc", not "stream", arguments) since gitpython-developers#519 when the change was made in a5db3d3 to fix a freezing bug. This updates the docstrings to reflect that they read from processes.
diff --git a/git/diff.py b/git/diff.py
@@ -486,10 +486,12 @@ def _pick_best_path(cls, path_match: bytes, rename_match: bytes, path_fallback_m
 
     @classmethod
     def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoInterrupt"]) -> DiffIndex:
-        """Create a new DiffIndex from the given text which must be in patch format
-        :param repo: is the repository we are operating on - it is required
-        :param stream: result of 'git diff' as a stream (supporting file protocol)
-        :return: git.DiffIndex"""
+        """Create a new DiffIndex from the given process output which must be in patch format.
+
+        :param repo: The repository we are operating on
+        :param proc: ``git diff`` process to read from (supports :class:`Git.AutoInterrupt` wrapper)
+        :return: git.DiffIndex
+        """
 
         ## FIXME: Here SLURPING raw, need to re-phrase header-regexes linewise.
         text_list: List[bytes] = []
@@ -644,8 +646,12 @@ def _handle_diff_line(lines_bytes: bytes, repo: "Repo", index: DiffIndex) -> Non
 
     @classmethod
     def _index_from_raw_format(cls, repo: "Repo", proc: "Popen") -> "DiffIndex":
-        """Create a new DiffIndex from the given stream which must be in raw format.
-        :return: git.DiffIndex"""
+        """Create a new DiffIndex from the given process output which must be in raw format.
+
+        :param repo: The repository we are operating on
+        :param proc: Process to read output from
+        :return: git.DiffIndex
+        """
         # handles
         # :100644 100644 687099101... 37c5e30c8... M    .gitignore
 
