summaryrefslogtreecommitdiff
path: root/paramiko/server.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-09-18 17:54:20 -0700
committerJeff Forcier <jeff@bitprophet.org>2014-09-18 17:54:20 -0700
commit233f0a422e3384584e20eff7330a536230d3cd31 (patch)
tree03bf3c41eed120f22bf2e3c7c4eda22ab39f2fd9 /paramiko/server.py
parent17dbb6a48c0ccf645bc8a53d22ba502a71a99a26 (diff)
downloadparamiko-233f0a422e3384584e20eff7330a536230d3cd31.tar.gz
Fix more missed epydoc syntax
Diffstat (limited to 'paramiko/server.py')
-rw-r--r--paramiko/server.py15
1 files changed, 6 insertions, 9 deletions
diff --git a/paramiko/server.py b/paramiko/server.py
index 496cd60c..2f630dfb 100644
--- a/paramiko/server.py
+++ b/paramiko/server.py
@@ -473,21 +473,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