From 37c93de3d31aabf32f0032a2a49a9fee285fa6e8 Mon Sep 17 00:00:00 2001 From: Eliah Kagan Date: Thu, 29 Feb 2024 03:44:44 -0500 Subject: [PATCH] A couple more small docstring refinements - Single vs. double backtick error/inconsistency in one place (parameter names were in in doubled backticks, now single) - Undo making "Iterator" in the phrase "Iterator yielding" a reference to collections.abc.Iterator, which is unnecessary and not done anywhere else. --- git/config.py | 4 ++-- git/util.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/git/config.py b/git/config.py index b358ee417..2164f67dc 100644 --- a/git/config.py +++ b/git/config.py @@ -920,8 +920,8 @@ def rename_section(self, section: str, new_name: str) -> "GitConfigParser": :raise ValueError: If: - * ``section`` doesn't exist. - * A section with ``new_name`` does already exist. + * `section` doesn't exist. + * A section with `new_name` does already exist. :return: This instance diff --git a/git/util.py b/git/util.py index bab765a09..52f9dbdad 100644 --- a/git/util.py +++ b/git/util.py @@ -1257,7 +1257,7 @@ def iter_items(cls, repo: "Repo", *args: Any, **kwargs: Any) -> Iterator[T_Itera keyword arguments, subclasses are obliged to to yield all items. :return: - :class:`~collections.abc.Iterator` yielding Items + Iterator yielding Items """ raise NotImplementedError("To be implemented by Subclass")