summaryrefslogtreecommitdiff
path: root/paramiko/ssh_exception.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2017-06-05 20:49:29 -0700
committerJeff Forcier <jeff@bitprophet.org>2017-06-05 23:02:31 -0700
commitfd94765e54272706b55e50c692c814d07c8008d1 (patch)
tree8ccbc1e9cf8f878aab6e79b5a08b6271d24aad9e /paramiko/ssh_exception.py
parent691f6191601366255d55176bcdb103987626cc86 (diff)
downloadparamiko-fd94765e54272706b55e50c692c814d07c8008d1.tar.gz
Move to 'inv sites' style doc nitpicking.
Existing just-warnings setup was old and not as rigorous as my usual. Required a lot of stupid little changes, but now same tooling for all projects, toot toot.
Diffstat (limited to 'paramiko/ssh_exception.py')
-rw-r--r--paramiko/ssh_exception.py18
1 files changed, 8 insertions, 10 deletions
diff --git a/paramiko/ssh_exception.py b/paramiko/ssh_exception.py
index 280a7f39..e9ab8d66 100644
--- a/paramiko/ssh_exception.py
+++ b/paramiko/ssh_exception.py
@@ -50,12 +50,10 @@ class BadAuthenticationType (AuthenticationException):
the server isn't allowing that type. (It may only allow public-key, for
example.)
- :ivar list allowed_types:
- list of allowed authentication types provided by the server (possible
- values are: ``"none"``, ``"password"``, and ``"publickey"``).
-
.. versionadded:: 1.1
"""
+ #: list of allowed authentication types provided by the server (possible
+ #: values are: ``"none"``, ``"password"``, and ``"publickey"``).
allowed_types = []
def __init__(self, explanation, types):
@@ -87,7 +85,7 @@ class ChannelException (SSHException):
"""
Exception raised when an attempt to open a new `.Channel` fails.
- :ivar int code: the error code returned by the server
+ :param int code: the error code returned by the server
.. versionadded:: 1.6
"""
@@ -102,9 +100,9 @@ class BadHostKeyException (SSHException):
"""
The host key given by the SSH server did not match what we were expecting.
- :ivar str hostname: the hostname of the SSH server
- :ivar PKey got_key: the host key presented by the server
- :ivar PKey expected_key: the host key expected
+ :param str hostname: the hostname of the SSH server
+ :param PKey got_key: the host key presented by the server
+ :param PKey expected_key: the host key expected
.. versionadded:: 1.6
"""
@@ -125,8 +123,8 @@ class ProxyCommandFailure (SSHException):
"""
The "ProxyCommand" found in the .ssh/config file returned an error.
- :ivar str command: The command line that is generating this exception.
- :ivar str error: The error captured from the proxy command output.
+ :param str command: The command line that is generating this exception.
+ :param str error: The error captured from the proxy command output.
"""
def __init__(self, command, error):
SSHException.__init__(self,