]> gitweb.factorcode.org Git - factor.git/commitdiff
better docs for smtp
authorDoug Coleman <doug.coleman@gmail.com>
Tue, 9 Sep 2008 23:55:49 +0000 (18:55 -0500)
committerDoug Coleman <doug.coleman@gmail.com>
Tue, 9 Sep 2008 23:55:49 +0000 (18:55 -0500)
basis/smtp/smtp-docs.factor

index e30b3fcc2706a7241264954fc3f433fc0e14ad54..435b04504d1f41bbb834d82fa789b43979108701 100644 (file)
@@ -20,8 +20,7 @@ HELP: <email>
 
 HELP: send-email
 { $values { "email" email } }
-{ $description "Sends an " { $link email } " object to an STMP server stored in the " { $link smtp-server } " variable.  The required slots are " { $snippet "from" } " and " { $snippet "to" } "." }
-
+{ $description "Sends an " { $link email } " object to an STMP server stored in the " { $link smtp-server } " variable.  The required slots are " { $slot "from" } " and " { $slot "to" } "." }
 { $examples
     { $unchecked-example "USING: accessors smtp ;"
     "<email>"
@@ -37,9 +36,5 @@ HELP: send-email
 } ;
 
 ARTICLE: "smtp" "SMTP Client Library"
-"Start by creating a new email object:"
-{ $subsection <email> }
-"Set the " { $snippet "from" } " slot to a " { $link string } "." $nl
-"Set the recipient fields, " { $snippet "to" } ", " { $snippet "cc" } ", and " { $snippet "bcc" } ", to arrays of strings."
-"Set the " { $snippet "subject" } " to a " { $link string } "." $nl
-"Set the " { $snippet "body" } " to a " { $link string } "." $nl ;
+"Sending an email:"
+{ $subsection send-email } ;