Content-Length: 2205 | pFad | http://github.com/gitpython-developers/GitPython/pull/1786.patch

thub.com From 501005f234e0d08c74463bf29592fe60a537c0d4 Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Sat, 23 Dec 2023 19:49:34 -0500 Subject: [PATCH] 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, correcting the errors from dfee31f (#1780) and 2b768c7 (#1785) so the docstrings make sense and references to further information are to places with that information. --- git/util.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/git/util.py b/git/util.py index 110961b93..f6e9b1945 100644 --- a/git/util.py +++ b/git/util.py @@ -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") @@ -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 @@ -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 """

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!