summaryrefslogtreecommitdiff
path: root/lib/git/repo/base.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2010-11-21 17:48:03 +0100
committerSebastian Thiel <byronimo@gmail.com>2010-11-21 17:48:03 +0100
commit0b813371f5a8af95152cae109d28c7c97bfaf79f (patch)
tree766bcee6c13c0b443d4afc69e1c7e68a1ab7910a /lib/git/repo/base.py
parent9d6310db456de9952453361c860c3ae61b8674ea (diff)
downloadgitpython-0b813371f5a8af95152cae109d28c7c97bfaf79f.tar.gz
Fixed API reference docs as far as possible
Diffstat (limited to 'lib/git/repo/base.py')
-rw-r--r--lib/git/repo/base.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/git/repo/base.py b/lib/git/repo/base.py
index aa00d028..6f401628 100644
--- a/lib/git/repo/base.py
+++ b/lib/git/repo/base.py
@@ -226,12 +226,13 @@ class Repo(object):
@property
def submodules(self):
- """:return: git.IterableList(Submodule, ...) of direct submodules
+ """
+ :return: git.IterableList(Submodule, ...) of direct submodules
available from the current head"""
return Submodule.list_items(self)
def submodule(self, name):
- """:return: Submodule with the given name
+ """ :return: Submodule with the given name
:raise ValueError: If no such submodule exists"""
try:
return self.submodules[name]
@@ -241,6 +242,7 @@ class Repo(object):
def create_submodule(self, *args, **kwargs):
"""Create a new submodule
+
:note: See the documentation of Submodule.add for a description of the
applicable parameters
:return: created submodules"""
@@ -719,7 +721,7 @@ class Repo(object):
"""Create a clone from the given URL
:param url: valid git url, see http://www.kernel.org/pub/software/scm/git/docs/git-clone.html#URLS
:param to_path: Path to which the repository should be cloned to
- :param **kwargs: see the ``clone`` method
+ :param kwargs: see the ``clone`` method
:return: Repo instance pointing to the cloned directory"""
return cls._clone(Git(os.getcwd()), url, to_path, GitCmdObjectDB, **kwargs)