diff options
| -rw-r--r-- | paramiko/file.py | 9 | ||||
| -rw-r--r-- | paramiko/kex_gex.py | 2 | ||||
| -rw-r--r-- | paramiko/server.py | 15 | ||||
| -rw-r--r-- | paramiko/transport.py | 5 |
4 files changed, 13 insertions, 18 deletions
diff --git a/paramiko/file.py b/paramiko/file.py index 09998829..311e1982 100644 --- a/paramiko/file.py +++ b/paramiko/file.py @@ -106,14 +106,13 @@ class BufferedFile (ClosingContextManager): else: def __next__(self): """ - Returns the next line from the input, or raises L{StopIteration} when + Returns the next line from the input, or raises `.StopIteration` when EOF is hit. Unlike python file objects, it's okay to mix calls to - C{next} and L{readline}. + `.next` and `.readline`. - @raise StopIteration: when the end of the file is reached. + :raises StopIteration: when the end of the file is reached. - @return: a line read from the file. - @rtype: str + :returns: a line (`str`) read from the file. """ line = self.readline() if not line: diff --git a/paramiko/kex_gex.py b/paramiko/kex_gex.py index 5ff8a287..cb548f33 100644 --- a/paramiko/kex_gex.py +++ b/paramiko/kex_gex.py @@ -19,7 +19,7 @@ """ Variant on `KexGroup1 <paramiko.kex_group1.KexGroup1>` where the prime "p" and generator "g" are provided by the server. A bit more work is required on the -client side, and a B{lot} more on the server side. +client side, and a **lot** more on the server side. """ import os diff --git a/paramiko/server.py b/paramiko/server.py index cf396b15..bf5039a2 100644 --- a/paramiko/server.py +++ b/paramiko/server.py @@ -547,21 +547,18 @@ class ServerInterface (object): def check_channel_env_request(self, channel, name, value): """ Check whether a given environment variable can be specified for the - given channel. This method should return C{True} if the server + given channel. This method should return ``True`` if the server is willing to set the specified environment variable. Note that some environment variables (e.g., PATH) can be exceedingly dangerous, so blindly allowing the client to set the environment is almost certainly not a good idea. - The default implementation always returns C{False}. + The default implementation always returns ``False``. - @param channel: the L{Channel} the env request arrived on - @type channel: L{Channel} - @param name: foo bar baz - @type name: str - @param value: flklj - @type value: str - @rtype: bool + :param channel: the `.Channel` the env request arrived on + :param str name: name + :param str value: Channel value + :returns: A boolean """ return False diff --git a/paramiko/transport.py b/paramiko/transport.py index b465aa00..2ffc8ca8 100644 --- a/paramiko/transport.py +++ b/paramiko/transport.py @@ -1067,10 +1067,9 @@ class Transport (threading.Thread, ClosingContextManager): def get_banner(self): """ Return the banner supplied by the server upon connect. If no banner is - supplied, this method returns C{None}. + supplied, this method returns ``None``. - @return: server supplied banner, or C{None}. - @rtype: string + :returns: server supplied banner (`str`), or ``None``. """ if not self.active or (self.auth_handler is None): return None |