update documentation for new Jabber::Simple#deliver syntax

git-svn-id: https://xmpp4r-simple.googlecode.com/svn/trunk@28 1e3c5029-9921-0410-9e82-436f4d538387
zencoder · Jan 23, 2007 · a936a86 · a936a86
1 parent 4bd0314
commit a936a86
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/xmpp4r-simple.rb b/lib/xmpp4r-simple.rb
@@ -103,6 +103,9 @@ def inspect #:nodoc:
     # If the recipient is not in your contacts list, the message will be queued
     # for later delivery, and the Contact will be automatically asked for
     # authorization (see Jabber::Simple#add).
+    #
+    # message should be a string or a valid Jabber::Message object. In either case,
+    # the message recipient will be set to jid.
     def deliver(jid, message, type=:chat)
       contacts(jid) do |friend|
         unless subscribed_to? friend