Fix Repo.iter_commits docstring about return type

EliahKagan · EliahKagan · commit 0c8ca1a9bdc7 · 2024-02-27T18:45:26.000-05:00
It had said it returned a list of Commit objects, but it returns an
iterator of Commit objects.
diff --git a/git/repo/base.py b/git/repo/base.py
@@ -692,7 +692,7 @@ def iter_commits(
         paths: Union[PathLike, Sequence[PathLike]] = "",
         **kwargs: Any,
     ) -> Iterator[Commit]:
-        """A list of Commit objects representing the history of a given ref/commit.
+        """An iterator of Commit objects representing the history of a given ref/commit.
 
         :param rev:
             Revision specifier, see git-rev-parse for viable options.
@@ -708,7 +708,7 @@ def iter_commits(
         :note: To receive only commits between two named revisions, use the
             ``"revA...revB"`` revision specifier.
 
-        :return: ``git.Commit[]``
+        :return: Iterator of ``git.Commit``
         """
         if rev is None:
             rev = self.head.commit
