openstack/deb-python-pygit2
Code Issues Proposed changes

Merge remote-tracking branch 'djmattyg007/doc_updates'

Browse Source
This commit is contained in:
J. David Ibáñez
2014-08-20 16:34:01 +02:00
parent 6c4e1d093b d752e8550b
commit f0631868af
3 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/conf.py
View File

@@ -11,12 +11,14 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys, os import sys, os, platform
from string import digits
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../build/lib.linux-x86_64-2.7')) version_string = sys.platform.rstrip(digits) + "-" + os.uname()[4] + "-" + ".".join(platform.python_version_tuple()[0:2])
sys.path.insert(0, os.path.abspath('../build/lib.' + version_string))
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------

6
pygit2/credentials.py
View File

@@ -61,6 +61,12 @@ class Keypair(object):
This is an object suitable for passing to a remote's credentials This is an object suitable for passing to a remote's credentials
callback and for returning from said callback. callback and for returning from said callback.
:param str username: the username being used to authenticate with the
remote server
:param str pubkey: the path to the user's public key file
:param str privkey: the path to the user's private key file
:param str passphrase: the password used to decrypt the private key file
""" """
def __init__(self, username, pubkey, privkey, passphrase): def __init__(self, username, pubkey, privkey, passphrase):

4
pygit2/remote.py
View File

@@ -49,7 +49,7 @@ class TransferProgress(object):
def __init__(self, tp): def __init__(self, tp):
self.total_objects = tp.total_objects self.total_objects = tp.total_objects
"""Total number objects to download""" """Total number of objects to download"""
self.indexed_objects = tp.indexed_objects self.indexed_objects = tp.indexed_objects
"""Objects which have been indexed""" """Objects which have been indexed"""
@@ -291,7 +291,7 @@ class Remote(object):
def push(self, spec, signature=None, message=None): def push(self, spec, signature=None, message=None):
"""push(refspec, signature, message) """push(refspec, signature, message)
Push the given refspec to the remote. Raises ``GitError`` on error Push the given refspec to the remote. Raises ``GitError`` on error.
:param str spec: push refspec to use :param str spec: push refspec to use
:param Signature signature: signature to use when updating the tips :param Signature signature: signature to use when updating the tips