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/repo/base.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/repo/base.py')
-rw-r--r-- | git/repo/base.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/git/repo/base.py b/git/repo/base.py index d4463f1e..93ed0c71 100644 --- a/git/repo/base.py +++ b/git/repo/base.py @@ -403,6 +403,7 @@ class Repo(object): @property def remotes(self) -> "IterableList[Remote]": """A list of Remote objects allowing to access and manipulate remotes + :return: ``git.IterableList(Remote, ...)``""" return Remote.list_items(self) @@ -443,6 +444,7 @@ class Repo(object): def iter_submodules(self, *args: Any, **kwargs: Any) -> Iterator[Submodule]: """An iterator yielding Submodule instances, see Traversable interface for a description of args and kwargs + :return: Iterator""" return RootModule(self).traverse(*args, **kwargs) @@ -457,6 +459,7 @@ class Repo(object): @property def tags(self) -> "IterableList[TagReference]": """A list of ``Tag`` objects that are available in this repo + :return: ``git.IterableList(TagReference, ...)``""" return TagReference.list_items(self) |