Commit0094e3d

committed

Fix incompletely revised Iterable/IterableObj docstrings

Three wrong references in docstrings to list_items methods hadaccidentally remained: one that was meant to be removed altogether,and two that were meant to be references to iter_items.This completes those changes, so the docstrings make sense andreferences to further information are to places that have thatinformation.

1 parent619304c commit0094e3dCopy full SHA for 0094e3d

File tree

1 file changed

-4

lines changed

git
- util.py

1 file changed

-4

lines changed

`‎git/util.py`

Lines changed: 2 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -1204,8 +1204,6 @@ def iter_items(cls, repo: "Repo", args: Any, *kwargs: Any) -> Iterator[T_Itera`
`1204`	`1204`	`filtering. However, when the method is called with no additional positional or`
`1205`	`1205`	`keyword arguments, subclasses are obliged to to yield all items.`
`1206`	`1206`
`1207`		`- For more information about the arguments, see list_items.`
`1208`		`-`
`1209`	`1207`	`:return: Iterator yielding Items`
`1210`	`1208`	`"""`
`1211`	`1209`	`raiseNotImplementedError("To be implemented by Subclass")`
`@@ -1214,7 +1212,7 @@ def iter_items(cls, repo: "Repo", args: Any, *kwargs: Any) -> Iterator[T_Itera`
`1214`	`1212`	`deflist_items(cls,repo:"Repo",args:Any,*kwargs:Any)->IterableList[T_IterableObj]:`
`1215`	`1213`	`"""Find (all) items of this type and collect them into a list.`
`1216`	`1214`
`1217`		- For more information about the arguments, see :meth:`list_items`.
	`1215`	+ For more information about the arguments, see :meth:`iter_items`.
`1218`	`1216`
`1219`	`1217`	:note: Favor the :meth:`iter_items` method as it will avoid eagerly collecting
`1220`	`1218`	`all items. When there are many items, that can slow performance and increase`
`@@ -1261,7 +1259,7 @@ def iter_items(cls, repo: "Repo", args: Any, *kwargs: Any) -> Any:`
`1261`	`1259`
`1262`	`1260`	`Find (all) items of this type.`
`1263`	`1261`
`1264`		- See :meth:`IterableObj.list_items` for details on usage.
	`1262`	+ See :meth:`IterableObj.iter_items` for details on usage.
`1265`	`1263`
`1266`	`1264`	`:return: Iterator yielding Items`
`1267`	`1265`	`"""`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit0094e3d

File tree

1 file changed

1 file changed

`‎git/util.py`

0 commit comments