From 44636240a08bba4a13355a5a23543d537ff15576 Mon Sep 17 00:00:00 2001 From: Stephan Creutz Date: Thu, 29 Dec 2022 14:50:43 +0100 Subject: 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. --- git/repo/base.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'git/repo/base.py') 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) -- cgit v1.2.1