diff options
| author | Jeff Forcier <jeff@bitprophet.org> | 2017-06-05 20:49:29 -0700 |
|---|---|---|
| committer | Jeff Forcier <jeff@bitprophet.org> | 2017-06-05 23:02:31 -0700 |
| commit | fd94765e54272706b55e50c692c814d07c8008d1 (patch) | |
| tree | 8ccbc1e9cf8f878aab6e79b5a08b6271d24aad9e /paramiko/sftp_handle.py | |
| parent | 691f6191601366255d55176bcdb103987626cc86 (diff) | |
| download | paramiko-fd94765e54272706b55e50c692c814d07c8008d1.tar.gz | |
Move to 'inv sites' style doc nitpicking.
Existing just-warnings setup was old and not as rigorous as my usual.
Required a lot of stupid little changes, but now same tooling for all
projects, toot toot.
Diffstat (limited to 'paramiko/sftp_handle.py')
| -rw-r--r-- | paramiko/sftp_handle.py | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/paramiko/sftp_handle.py b/paramiko/sftp_handle.py index 2d2e621c..ca473900 100644 --- a/paramiko/sftp_handle.py +++ b/paramiko/sftp_handle.py @@ -77,7 +77,7 @@ class SFTPHandle (ClosingContextManager): to be 64 bits. If the end of the file has been reached, this method may return an - empty string to signify EOF, or it may also return `.SFTP_EOF`. + empty string to signify EOF, or it may also return ``SFTP_EOF``. The default implementation checks for an attribute on ``self`` named ``readfile``, and if present, performs the read operation on the Python @@ -85,7 +85,6 @@ class SFTPHandle (ClosingContextManager): common case where you are wrapping a Python file object.) :param offset: position in the file to start reading from. - :type offset: int or long :param int length: number of bytes to attempt to read. :return: data read from the file, or an SFTP error code, as a `str`. """ @@ -120,9 +119,8 @@ class SFTPHandle (ClosingContextManager): refer to the same file. :param offset: position in the file to start reading from. - :type offset: int or long :param str data: data to write into the file. - :return: an SFTP error code like `.SFTP_OK`. + :return: an SFTP error code like ``SFTP_OK``. """ writefile = getattr(self, 'writefile', None) if writefile is None: @@ -152,7 +150,7 @@ class SFTPHandle (ClosingContextManager): :return: an attributes object for the given file, or an SFTP error code - (like `.SFTP_PERMISSION_DENIED`). + (like ``SFTP_PERMISSION_DENIED``). :rtype: `.SFTPAttributes` or error code """ return SFTP_OP_UNSUPPORTED @@ -164,7 +162,7 @@ class SFTPHandle (ClosingContextManager): check for the presence of fields before using them. :param .SFTPAttributes attr: the attributes to change on this file. - :return: an `int` error code like `.SFTP_OK`. + :return: an `int` error code like ``SFTP_OK``. """ return SFTP_OP_UNSUPPORTED |