diff options
| author | Stephan Creutz <stephan.cr@gmx.de> | 2022-12-29 14:50:43 +0100 |
|---|---|---|
| committer | Sebastian Thiel <sebastian.thiel@icloud.com> | 2022-12-29 21:54:43 +0100 |
| commit | 44636240a08bba4a13355a5a23543d537ff15576 (patch) | |
| tree | 58b8ffefce53940b18fd1afd11c590321758e0c5 /git/util.py | |
| parent | 141cd651e459bff8919798b3ccf03dfa167757f6 (diff) | |
| download | gitpython-44636240a08bba4a13355a5a23543d537ff15576.tar.gz | |
Fix Sphinx rendering errors
These errors are mostly fixed by either adding blank lines or single
spaces for Sphinx documentation key words.
The commit solely includes documentation changes, no functional
changes.
Diffstat (limited to 'git/util.py')
| -rw-r--r-- | git/util.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/git/util.py b/git/util.py index 6a4a6557..30028b1c 100644 --- a/git/util.py +++ b/git/util.py @@ -131,7 +131,7 @@ T = TypeVar("T") def unbare_repo(func: Callable[..., T]) -> Callable[..., T]: - """Methods with this decorator raise InvalidGitRepositoryError if they + """Methods with this decorator raise :class:`.exc.InvalidGitRepositoryError` if they encounter a bare repository""" from .exc import InvalidGitRepositoryError @@ -1152,7 +1152,7 @@ class Iterable(metaclass=IterableClassWatcher): :note: Favor the iter_items method as it will - :return:list(Item,...) list of item instances""" + :return: list(Item,...) list of item instances""" out_list: Any = IterableList(cls._id_attribute_) out_list.extend(cls.iter_items(repo, *args, **kwargs)) return out_list @@ -1184,7 +1184,7 @@ class IterableObj(Protocol): :note: Favor the iter_items method as it will - :return:list(Item,...) list of item instances""" + :return: list(Item,...) list of item instances""" out_list: IterableList = IterableList(cls._id_attribute_) out_list.extend(cls.iter_items(repo, *args, **kwargs)) return out_list |