Further clarified purpose of user field in docstring for Keypair class
This commit is contained in:
@@ -61,7 +61,8 @@ 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 used in the remote URL
|
: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 pubkey: the path to the user's public key file
|
||||||
:param str privkey: the path to the user's private 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
|
:param str passphrase: the password used to decrypt the private key file
|
||||||
|
Reference in New Issue
Block a user