Document list of parameters for the Keypair credential callback.

Includes a couple of small grammar fixes to other docstrings.
This commit is contained in:
djmattyg007
2014-08-05 18:59:40 +10:00
parent f98dc8264a
commit f787a52e66
2 changed files with 7 additions and 2 deletions

View File

@@ -61,6 +61,11 @@ class Keypair(object):
This is an object suitable for passing to a remote's credentials
callback and for returning from said callback.
:param str username: the username used in the remote URL
: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):

View File

@@ -49,7 +49,7 @@ class TransferProgress(object):
def __init__(self, tp):
self.total_objects = tp.total_objects
"""Total number objects to download"""
"""Total number of objects to download"""
self.indexed_objects = tp.indexed_objects
"""Objects which have been indexed"""
@@ -291,7 +291,7 @@ class Remote(object):
def push(self, spec, signature=None, message=None):
"""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 Signature signature: signature to use when updating the tips