more documentation, to make the ri docs more useful

caring · Mar 14, 2008 · 8a162ed · 8a162ed
1 parent ebf5d53
commit 8a162ed
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 pkg
 doc
 coverage
+ri
diff --git a/lib/net/sftp.rb b/lib/net/sftp.rb
@@ -2,7 +2,14 @@
 require 'net/sftp/session'
 
 module Net
-
+
+  # Net::SFTP is a pure-Ruby module for programmatically interacting with a
+  # remote host via the SFTP protocol (that's SFTP as in "Secure File Transfer
+  # Protocol" produced by the Secure Shell Working Group, not "Secure FTP"
+  # and certainly not "Simple FTP").
+  #
+  # See Net::SFTP#start for an introduction to the library. Also, see
+  # Net::SFTP::Session for further documentation.
   module SFTP
     # A convenience method for starting a standalone SFTP session. It will
     # start up an SSH session using the given arguments (see the documentation

diff --git a/lib/net/sftp/session.rb b/lib/net/sftp/session.rb
@@ -109,7 +109,7 @@ def upload!(local, remote, options={}, &block)
       # Net::SFTP::Operations::Download for a full discussion of hos this method can be
       # used.
       #
-      #   download = sftp.downnload("/remote/path", "/local/path")
+      #   download = sftp.download("/remote/path", "/local/path")
       #   download.wait
       def download(remote, local, options={}, &block)
         Operations::Download.new(self, local, remote, options, &block)