Skip to content

Commit

Permalink
Merge branch '1.13' into 1.14
Browse files Browse the repository at this point in the history
  • Loading branch information
bitprophet committed Sep 19, 2014
2 parents b3bae9a + 83f54e4 commit a200676
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 18 deletions.
9 changes: 4 additions & 5 deletions paramiko/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,14 +104,13 @@ def next(self):
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:
Expand Down
2 changes: 1 addition & 1 deletion paramiko/kex_gex.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
15 changes: 6 additions & 9 deletions paramiko/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -473,21 +473,18 @@ def check_channel_direct_tcpip_request(self, chanid, origin, destination):
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

Expand Down
5 changes: 2 additions & 3 deletions paramiko/transport.py
Original file line number Diff line number Diff line change
Expand Up @@ -961,10 +961,9 @@ def get_username(self):
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
Expand Down

0 comments on commit a200676

Please sign in to comment.