summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-02-25 16:57:54 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-02-25 16:57:54 -0800
commit33452b2e6c7f7c48d7bfa6fcf770b1d27d6af2d6 (patch)
tree325e10056c7d9314c49bf5ad774d73ef5182985b
parente293dff6533c5b39ef5b98e849d3fdb4a2c70e15 (diff)
Random reformat/fixing-up of Channel
-rw-r--r--paramiko/channel.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py
index 630a60c8..85d988b6 100644
--- a/paramiko/channel.py
+++ b/paramiko/channel.py
@@ -347,7 +347,7 @@ class Channel (object):
If a handler is passed in, the handler is called from another thread
whenever a new x11 connection arrives. The default handler queues up
incoming x11 connections, which may be retrieved using
- `Transport.accept`. The handler's calling signature is::
+ `.Transport.accept`. The handler's calling signature is::
handler(channel: Channel, (address: str, port: int))
@@ -392,7 +392,7 @@ class Channel (object):
def request_forward_agent(self, handler):
"""
Request for a forward SSH Agent on this channel.
- This is only valid for an ssh-agent from openssh !!!
+ This is only valid for an ssh-agent from OpenSSH !!!
:param handler: a required handler to use for incoming SSH Agent connections
:type handler: function
@@ -447,7 +447,7 @@ class Channel (object):
"""
Return the ID # for this channel. The channel ID is unique across
a `.Transport` and usually a small number. It's also the number
- passed to `ServerInterface.check_channel_request` when determining
+ passed to `.ServerInterface.check_channel_request` when determining
whether to accept a channel request in server mode.
:return: the ID of this channel.
@@ -1230,10 +1230,12 @@ class ChannelFile (BufferedFile):
A file-like wrapper around `.Channel`. A ChannelFile is created by calling
`Channel.makefile`.
- @bug: To correctly emulate the file object created from a socket's
- ``makefile`` method, a `.Channel` and its ``ChannelFile`` should be able
- to be closed or garbage-collected independently. Currently, closing
- the ``ChannelFile`` does nothing but flush the buffer.
+ .. warning::
+ To correctly emulate the file object created from a socket's `makefile
+ <python:socket.socket.makefile>` method, a `.Channel` and its
+ `.ChannelFile` should be able to be closed or garbage-collected
+ independently. Currently, closing the `ChannelFile` does nothing but
+ flush the buffer.
"""
def __init__(self, channel, mode = 'r', bufsize = -1):