Skip to content

Navigation Menu

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0094e3d

Browse filesBrowse files
committed
Fix incompletely revised Iterable/IterableObj docstrings
Three wrong references in docstrings to list_items methods had accidentally 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 and references to further information are to places that have that information.
1 parent 619304c commit 0094e3d
Copy full SHA for 0094e3d

File tree

1 file changed

+2
-4
lines changed
Filter options

1 file changed

+2
-4
lines changed

‎git/util.py

Copy file name to clipboardExpand all lines: git/util.py
+2-4Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1204,8 +1204,6 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Iterator[T_Itera
12041204
filtering. However, when the method is called with no additional positional or
12051205
keyword arguments, subclasses are obliged to to yield all items.
12061206
1207-
For more information about the arguments, see list_items.
1208-
12091207
:return: Iterator yielding Items
12101208
"""
12111209
raise NotImplementedError("To be implemented by Subclass")
@@ -1214,7 +1212,7 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Iterator[T_Itera
12141212
def list_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> IterableList[T_IterableObj]:
12151213
"""Find (all) items of this type and collect them into a list.
12161214
1217-
For more information about the arguments, see :meth:`list_items`.
1215+
For more information about the arguments, see :meth:`iter_items`.
12181216
12191217
:note: Favor the :meth:`iter_items` method as it will avoid eagerly collecting
12201218
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:
12611259
12621260
Find (all) items of this type.
12631261
1264-
See :meth:`IterableObj.list_items` for details on usage.
1262+
See :meth:`IterableObj.iter_items` for details on usage.
12651263
12661264
:return: Iterator yielding Items
12671265
"""

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.