]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/combinators/short-circuit/smart/smart-docs.factor
factor: trim using lists
[factor.git] / basis / combinators / short-circuit / smart / smart-docs.factor
index abf3ff0eef7e5da9a135c938d779bd2d72ad9480..10695086a09858493dd3e079c175327a4a379a6f 100644 (file)
@@ -1,13 +1,13 @@
 ! Copyright (C) 2008 Doug Coleman.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax io.streams.string quotations ;
+USING: help.markup help.syntax quotations ;
 IN: combinators.short-circuit.smart
 
 HELP: &&
 { $values
      { "quots" "a sequence of quotations" }
      { "quot" quotation } }
-{ $description "Infers the number of arguments that each quotation takes from the stack. Eacn quotation must take the same number of arguments. Returns true if every quotation yields true, and stops early if one yields false." }
+{ $description "Infers the number of arguments that each quotation takes from the stack. Each quotation must take the same number of arguments. Returns true if every quotation yields true, and stops early if one yields false." }
 { $examples "Smart combinators will infer the two inputs:"
     { $example "USING: prettyprint kernel math combinators.short-circuit.smart ;"
     "2 3 { [ + 5 = ] [ - -1 = ] } && ."
@@ -19,7 +19,7 @@ HELP: ||
 { $values
      { "quots" "a sequence of quotations" }
      { "quot" quotation } }
-{ $description "Infers the number of arguments that each quotation takes from the stack. Eacn quotation must take the same number of arguments. Returns true if any quotation yields true, and stops early when one yields true." }
+{ $description "Infers the number of arguments that each quotation takes from the stack. Each quotation must take the same number of arguments. Returns true if any quotation yields true, and stops early when one yields true." }
 { $examples "Smart combinators will infer the two inputs:"
     { $example "USING: prettyprint kernel math combinators.short-circuit.smart ;"
     "2 3 { [ - 1 = ] [ + 5 = ] } || ."
@@ -27,11 +27,12 @@ HELP: ||
     }
 } ;
 
-ARTICLE: "combinators.short-circuit.smart" "combinators.short-circuit.smart"
-"The " { $vocab-link "combinators.short-circuit.smart" } " vocabulary infers the number of inputs that the sequence of quotations takes." $nl
+ARTICLE: "combinators.short-circuit.smart" "Smart short-circuit combinators"
+"The " { $vocab-link "combinators.short-circuit.smart" } " vocabulary is similar to " { $vocab-link "combinators.short-circuit" } " except the combinators here infer the number of inputs that the sequence of quotations takes."
+$nl
 "Generalized AND:"
-{ $subsection && }
+{ $subsections && }
 "Generalized OR:"
-{ $subsection || } ;
+{ $subsections || } ;
 
 ABOUT: "combinators.short-circuit.smart"