Skip to content

Commit f787a52

Browse files
committed
Document list of parameters for the Keypair credential callback.
Includes a couple of small grammar fixes to other docstrings.
1 parent f98dc82 commit f787a52

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

pygit2/credentials.py

+5
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@ class Keypair(object):
6161
This is an object suitable for passing to a remote's credentials
6262
callback and for returning from said callback.
6363
64+
:param str username: the username used in the remote URL
65+
:param str pubkey: the path to the user's public key file
66+
:param str privkey: the path to the user's private key file
67+
:param str passphrase: the password used to decrypt the private key file
68+
6469
"""
6570

6671
def __init__(self, username, pubkey, privkey, passphrase):

pygit2/remote.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class TransferProgress(object):
4949
def __init__(self, tp):
5050

5151
self.total_objects = tp.total_objects
52-
"""Total number objects to download"""
52+
"""Total number of objects to download"""
5353

5454
self.indexed_objects = tp.indexed_objects
5555
"""Objects which have been indexed"""
@@ -291,7 +291,7 @@ def _push_cb(ref, msg, data):
291291
def push(self, spec, signature=None, message=None):
292292
"""push(refspec, signature, message)
293293
294-
Push the given refspec to the remote. Raises ``GitError`` on error
294+
Push the given refspec to the remote. Raises ``GitError`` on error.
295295
296296
:param str spec: push refspec to use
297297
:param Signature signature: signature to use when updating the tips

0 commit comments

Comments
 (0)