Merge remote-tracking branch 'djmattyg007/doc_updates'

Author: jdavid

docs/conf.py

@@ -11,12 +11,14 @@
 # All configuration values have a default; values that are commented out
 # 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,
 # 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.
-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 -----------------------------------------------------
 

pygit2/credentials.py

@@ -61,6 +61,12 @@ 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 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):

pygit2/remote.py

@@ -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 @@ def _push_cb(ref, msg, data):
     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