Start in on the SFTP section

paramiko/sftp_attr.py

@@ -26,8 +26,8 @@ class SFTPAttributes (object):
     """
     Representation of the attributes of a file (or proxied file) for SFTP in
     client or server mode.  It attemps to mirror the object returned by
-    ``os.stat`` as closely as possible, so it may have the following fields,
-    with the same meanings as those returned by an ``os.stat`` object:
+    `os.stat` as closely as possible, so it may have the following fields,
+    with the same meanings as those returned by an `os.stat` object:
         - st_size
         - st_uid
         - st_gid

paramiko/sftp_client.py

@@ -16,9 +16,6 @@
 # along with Paramiko; if not, write to the Free Software Foundation, Inc.,
 # 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 
-"""
-Client-mode SFTP support.
-"""
 
 from binascii import hexlify
 import errno
@@ -51,10 +48,11 @@ def _to_unicode(s):
 
 class SFTPClient(BaseSFTP):
     """
-    SFTP client object.  ``SFTPClient`` is used to open an sftp session across
-    an open ssh `.Transport` and do remote file operations.
-    """
+    SFTP client object.
     
+    Used to open an SFTP session across an open SSH `.Transport` and perform
+    remote file operations.
+    """
     def __init__(self, sock):
         """
         Create an SFTP client from an existing `.Channel`.  The channel
@@ -783,5 +781,7 @@ class SFTPClient (BaseSFTP):
 
 
 class SFTP(SFTPClient):
-    "an alias for `.SFTPClient` for backwards compatability"
+    """
+    An alias for `.SFTPClient` for backwards compatability.
+    """
     pass

sites/docs/api/sftp.rst

@@ -2,9 +2,9 @@ SFTP
 ====
 
 .. automodule:: paramiko.sftp
-.. automodule:: paramiko.sftp_attr
 .. automodule:: paramiko.sftp_client
+.. automodule:: paramiko.sftp_server
+.. automodule:: paramiko.sftp_attr
 .. automodule:: paramiko.sftp_file
 .. automodule:: paramiko.sftp_handle
-.. automodule:: paramiko.sftp_server
 .. automodule:: paramiko.sftp_si