[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-124]
docs fixup fix a comment typo, and add @since designators to a couple of new methods.
This commit is contained in:
parent
767d739299
commit
438673c11f
|
@ -490,6 +490,8 @@ class Channel (object):
|
||||||
@return: C{True} if a L{recv_stderr} call on this channel would
|
@return: C{True} if a L{recv_stderr} call on this channel would
|
||||||
immediately return at least one byte; C{False} otherwise.
|
immediately return at least one byte; C{False} otherwise.
|
||||||
@rtype: boolean
|
@rtype: boolean
|
||||||
|
|
||||||
|
@since: 1.1
|
||||||
"""
|
"""
|
||||||
self.lock.acquire()
|
self.lock.acquire()
|
||||||
try:
|
try:
|
||||||
|
@ -515,6 +517,8 @@ class Channel (object):
|
||||||
|
|
||||||
@raise socket.timeout: if no data is ready before the timeout set by
|
@raise socket.timeout: if no data is ready before the timeout set by
|
||||||
L{settimeout}.
|
L{settimeout}.
|
||||||
|
|
||||||
|
@since: 1.1
|
||||||
"""
|
"""
|
||||||
out = ''
|
out = ''
|
||||||
self.lock.acquire()
|
self.lock.acquire()
|
||||||
|
@ -653,6 +657,8 @@ class Channel (object):
|
||||||
|
|
||||||
@return: object which can be used for python file I/O.
|
@return: object which can be used for python file I/O.
|
||||||
@rtype: L{ChannelFile}
|
@rtype: L{ChannelFile}
|
||||||
|
|
||||||
|
@since: 1.1
|
||||||
"""
|
"""
|
||||||
return ChannelStderrFile(*([self] + list(params)))
|
return ChannelStderrFile(*([self] + list(params)))
|
||||||
|
|
||||||
|
|
|
@ -97,7 +97,7 @@ class SFTPServer (BaseSFTP, SubsystemHandler):
|
||||||
|
|
||||||
@param e: an errno code, as from C{OSError.errno}.
|
@param e: an errno code, as from C{OSError.errno}.
|
||||||
@type e: int
|
@type e: int
|
||||||
@return: an SFTP error code like L{SFTP_NO_SUCH_fILE}.
|
@return: an SFTP error code like L{SFTP_NO_SUCH_FILE}.
|
||||||
@rtype: int
|
@rtype: int
|
||||||
"""
|
"""
|
||||||
if e == errno.EACCES:
|
if e == errno.EACCES:
|
||||||
|
|
Loading…
Reference in New Issue