summaryrefslogtreecommitdiff
path: root/paramiko/pkey.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2015-11-02 17:06:11 -0800
committerJeff Forcier <jeff@bitprophet.org>2015-11-02 17:06:11 -0800
commite73dc7751bb2ad360308f43918f6bd62aefbb085 (patch)
treedf95af9ddeda97e68719b0f29237ab0cca93ef8c /paramiko/pkey.py
parente6593de3b5ebb88a9a32d8e83245726d394a2646 (diff)
downloadparamiko-e73dc7751bb2ad360308f43918f6bd62aefbb085.tar.gz
Fix a handful of non-strict warnings in the Sphinx docs.
Turns out there's a reason we haven't run the strict checker (sphinx-build -nW) before - it tries to resolve literally every info-list field like ':raises IOError:' and sphinx is apparently not cool enough to mesh that with intersphinx.
Diffstat (limited to 'paramiko/pkey.py')
-rw-r--r--paramiko/pkey.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/paramiko/pkey.py b/paramiko/pkey.py
index d8018e70..472c1287 100644
--- a/paramiko/pkey.py
+++ b/paramiko/pkey.py
@@ -192,7 +192,7 @@ class PKey (object):
``None``, the given password will be used to decrypt the key (otherwise
`.PasswordRequiredException` is thrown).
- :param file file_obj: the file to read from
+ :param file_obj: the file-like object to read from
:param str password:
an optional password to use to decrypt the key, if it's encrypted
:return: a new `.PKey` based on the given private key
@@ -225,7 +225,7 @@ class PKey (object):
Write private key contents into a file (or file-like) object. If the
password is not ``None``, the key is encrypted before writing.
- :param file file_obj: the file object to write into
+ :param file_obj: the file-like object to write into
:param str password: an optional password to use to encrypt the key
:raises IOError: if there was an error writing to the file
@@ -311,8 +311,9 @@ class PKey (object):
a trivially-encoded format (base64) which is completely insecure. If
a password is given, DES-EDE3-CBC is used.
- :param str tag: ``"RSA"`` or ``"DSA"``, the tag used to mark the data block.
- :param file filename: name of the file to write.
+ :param str tag:
+ ``"RSA"`` or ``"DSA"``, the tag used to mark the data block.
+ :param filename: name of the file to write.
:param str data: data blob that makes up the private key.
:param str password: an optional password to use to encrypt the file.