summaryrefslogtreecommitdiff
path: root/git/repo/base.py
diff options
context:
space:
mode:
authorSebastian Thiel <byronimo@gmail.com>2015-01-14 17:47:44 +0100
committerSebastian Thiel <byronimo@gmail.com>2015-01-14 17:49:33 +0100
commit6569c4849197c9475d85d05205c55e9ef28950c1 (patch)
tree3dfb25f7c23a74e466e43ab6db87eeb4290712a7 /git/repo/base.py
parent53e5fb3733e491925a01e9da6243e93c2e4214c1 (diff)
downloadgitpython-6569c4849197c9475d85d05205c55e9ef28950c1.tar.gz
Fixed some doc strings to build correctly with sphinx
Fixes #7 [ci skip]
Diffstat (limited to 'git/repo/base.py')
-rw-r--r--git/repo/base.py26
1 files changed, 12 insertions, 14 deletions
diff --git a/git/repo/base.py b/git/repo/base.py
index afff9471..6d9af6d4 100644
--- a/git/repo/base.py
+++ b/git/repo/base.py
@@ -461,7 +461,8 @@ class Repo(object):
return Commit.iter_items(self, rev, paths, **kwargs)
def merge_base(self, *rev, **kwargs):
- """Find the closest common ancestor for the given revision (e.g. Commits, Tags, References, etc).
+ """Find the closest common ancestor for the given revision (e.g. Commits, Tags, References, etc)
+
:param rev: At least two revs to find the common ancestor for.
:param kwargs: Additional arguments to be passed to the repo.git.merge_base() command which does all the work.
:return: A list of Commit objects. If --all was not specified as kwarg, the list will have at max one Commit,
@@ -814,16 +815,13 @@ class Repo(object):
def clone(self, path, progress=None, **kwargs):
"""Create a clone from this repository.
- :param path:
- is the full path of the new repo (traditionally ends with ./<name>.git).
+ :param path: is the full path of the new repo (traditionally ends with ./<name>.git).
:param progress: See 'git.remote.Remote.push'.
-
:param kwargs:
- odbt = ObjectDatabase Type, allowing to determine the object database
- implementation used by the returned Repo instance
-
- All remaining keyword arguments are given to the git-clone command
+ * odbt = ObjectDatabase Type, allowing to determine the object database
+ implementation used by the returned Repo instance
+ * All remaining keyword arguments are given to the git-clone command
:return: ``git.Repo`` (the newly cloned repo)"""
return self._clone(self.git, self.git_dir, path, type(self.odb), progress, **kwargs)
@@ -840,16 +838,16 @@ class Repo(object):
def archive(self, ostream, treeish=None, prefix=None, **kwargs):
"""Archive the tree at the given revision.
+
:parm ostream: file compatible stream object to which the archive will be written as bytes
:parm treeish: is the treeish name/id, defaults to active branch
:parm prefix: is the optional prefix to prepend to each filename in the archive
- :parm kwargs:
- Additional arguments passed to git-archive
- NOTE: Use the 'format' argument to define the kind of format. Use
- specialized ostreams to write any format supported by python.
+ :parm kwargs: Additional arguments passed to git-archive
- You may specify the special 'path' keyword, which may either be a repository-relative
- path to a directory or file to place into the archive, or a list or tuple of multipe paths.
+ * Use the 'format' argument to define the kind of format. Use
+ specialized ostreams to write any format supported by python.
+ * You may specify the special **path** keyword, which may either be a repository-relative
+ path to a directory or file to place into the archive, or a list or tuple of multipe paths.
:raise GitCommandError: in case something went wrong
:return: self"""