Skip to content

Fix incompletely revised Iterable/IterableObj docstrings #1786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 24, 2023
Merged

Fix incompletely revised Iterable/IterableObj docstrings #1786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions git/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1204,8 +1204,6 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Iterator[T_Itera
filtering. However, when the method is called with no additional positional or
keyword arguments, subclasses are obliged to to yield all items.

For more information about the arguments, see list_items.

:return: Iterator yielding Items
"""
raise NotImplementedError("To be implemented by Subclass")
Expand All @@ -1214,7 +1212,7 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Iterator[T_Itera
def list_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> IterableList[T_IterableObj]:
"""Find (all) items of this type and collect them into a list.

For more information about the arguments, see :meth:`list_items`.
For more information about the arguments, see :meth:`iter_items`.

:note: Favor the :meth:`iter_items` method as it will avoid eagerly collecting
all items. When there are many items, that can slow performance and increase
Expand Down Expand Up @@ -1261,7 +1259,7 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Any:

Find (all) items of this type.

See :meth:`IterableObj.list_items` for details on usage.
See :meth:`IterableObj.iter_items` for details on usage.

:return: Iterator yielding Items
"""
Expand Down