Skip to content

Commit

Permalink
A couple more small docstring refinements
Browse files Browse the repository at this point in the history
- 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.
  • Loading branch information
EliahKagan committed Feb 29, 2024
1 parent f43292e commit 37c93de
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions git/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion git/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down

0 comments on commit 37c93de

Please sign in to comment.