Skip to content

Commit

Permalink
Fix a handful of non-strict warnings in the Sphinx docs.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
bitprophet committed Nov 3, 2015
1 parent e6593de commit e73dc77
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion paramiko/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def parse(self, file_obj):
"""
Read an OpenSSH config from the given file object.
:param file file_obj: a file-like object to read the config file from
:param file_obj: a file-like object to read the config file from
"""
host = {"host": ['*'], "config": {}}
for line in file_obj:
Expand Down
9 changes: 5 additions & 4 deletions paramiko/pkey.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def from_private_key(cls, file_obj, password=None):
``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
Expand Down Expand Up @@ -225,7 +225,7 @@ def write_private_key(self, file_obj, password=None):
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
Expand Down Expand Up @@ -311,8 +311,9 @@ def _write_private_key_file(self, tag, filename, data, password=None):
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.
Expand Down
2 changes: 1 addition & 1 deletion paramiko/sftp_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ def putfo(self, fl, remotepath, file_size=0, callback=None, confirm=True):
The SFTP operations use pipelining for speed.
:param file fl: opened file or file-like object to copy
:param fl: opened file or file-like object to copy
:param str remotepath: the destination path on the SFTP server
:param int file_size:
optional size parameter passed to callback. If none is specified,
Expand Down

0 comments on commit e73dc77

Please sign in to comment.