summaryrefslogtreecommitdiff
path: root/paramiko
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2015-12-10 18:32:31 -0800
committerJeff Forcier <jeff@bitprophet.org>2015-12-10 18:32:31 -0800
commit99db33d25a21fb87f497af063d736d113733567c (patch)
treed7af3d92b2d7bdf33c7ec45c64c20146d0e030a9 /paramiko
parentc859958924da10795a6460b5f040734bea394b03 (diff)
downloadparamiko-99db33d25a21fb87f497af063d736d113733567c.tar.gz
Fix ambiguous API refs causing sphinx to fart
Diffstat (limited to 'paramiko')
-rw-r--r--paramiko/channel.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/paramiko/channel.py b/paramiko/channel.py
index 8a1c0f87..44a4b291 100644
--- a/paramiko/channel.py
+++ b/paramiko/channel.py
@@ -306,11 +306,11 @@ class Channel (ClosingContextManager):
`.Transport` or session's ``window_size`` (e.g. that set by the
``default_window_size`` kwarg for `.Transport.__init__`) will cause
`.recv_exit_status` to hang indefinitely if it is called prior to a
- sufficiently large `.read` (or if there are no threads calling
- `.read` in the background).
+ sufficiently large `~Channel..read` (or if there are no threads
+ calling `~Channel.read` in the background).
In these cases, ensuring that `.recv_exit_status` is called *after*
- `.read` (or, again, using threads) can avoid the hang.
+ `~Channel.read` (or, again, using threads) can avoid the hang.
:return: the exit code (as an `int`) of the process on the server.