summaryrefslogtreecommitdiff
path: root/paramiko/channel.py
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2019-06-14 21:04:26 -0400
committerJeff Forcier <jeff@bitprophet.org>2019-06-14 21:05:23 -0400
commit72a068c2387daf37b2d369f774f818169f6e5f60 (patch)
tree039e7f67d5d923082efefa3f8f0a3d51090fe88d /paramiko/channel.py
parentdad77ab135152deda5c0dde879af2791f47b650f (diff)
downloadparamiko-72a068c2387daf37b2d369f774f818169f6e5f60.tar.gz
Add docstrings so Channel(Stderr|Stdin)File appear in Sphinx
Also tweak changelog a bit while I am making it render correctly...
Diffstat (limited to 'paramiko/channel.py')
-rw-r--r--paramiko/channel.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py
index 9f2d8f01..72f65012 100644
--- a/paramiko/channel.py
+++ b/paramiko/channel.py
@@ -1366,6 +1366,12 @@ class ChannelFile(BufferedFile):
class ChannelStderrFile(ChannelFile):
+ """
+ A file-like wrapper around `.Channel` stderr.
+
+ See `Channel.makefile_stderr` for details.
+ """
+
def _read(self, size):
return self.channel.recv_stderr(size)
@@ -1375,6 +1381,12 @@ class ChannelStderrFile(ChannelFile):
class ChannelStdinFile(ChannelFile):
+ """
+ A file-like wrapper around `.Channel` stdin.
+
+ See `Channel.makefile_stdin` for details.
+ """
+
def close(self):
super(ChannelStdinFile, self).close()
self.channel.shutdown_write()