Commit0c8ca1a

committed

Fix Repo.iter_commits docstring about return type

It had said it returned a list of Commit objects, but it returns aniterator of Commit objects.

1 parent4f67369 commit0c8ca1aCopy full SHA for 0c8ca1a

File tree

-2

lines changed

-2

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -692,7 +692,7 @@ def iter_commits(`
`692`	`692`	`paths:Union[PathLike,Sequence[PathLike]]="",`
`693`	`693`	`**kwargs:Any,`
`694`	`694`	`)->Iterator[Commit]:`
`695`		`-"""A list of Commit objects representing the history of a given ref/commit.`
	`695`	`+"""An iterator of Commit objects representing the history of a given ref/commit.`
`696`	`696`
`697`	`697`	`:param rev:`
`698`	`698`	`Revision specifier, see git-rev-parse for viable options.`
`@@ -708,7 +708,7 @@ def iter_commits(`
`708`	`708`	`:note: To receive only commits between two named revisions, use the`
`709`	`709`	``"revA...revB"`` revision specifier.
`710`	`710`
`711`		- :return: ``git.Commit[]``
	`711`	+ :return:Iterator of``git.Commit``
`712`	`712`	`"""`
`713`	`713`	`ifrevisNone:`
`714`	`714`	`rev=self.head.commit`

Comments

(0)