]> gitweb.factorcode.org Git - factor.git/commitdiff
Doc fixes
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Tue, 23 Sep 2008 21:14:34 +0000 (16:14 -0500)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Tue, 23 Sep 2008 21:14:34 +0000 (16:14 -0500)
basis/circular/circular-docs.factor
basis/combinators/short-circuit/short-circuit-docs.factor
basis/combinators/short-circuit/smart/smart-docs.factor

index 362d41c9de7df184877d30b9a304cc68fb7bd173..c7af57c1feba64ada3bd3fd04d596eb12b5540e4 100644 (file)
@@ -43,7 +43,7 @@ HELP: push-growing-circular
      { "elt" object } { "circular" circular } }
 { $description "Pushes an element onto a " { $link growing-circular } " object." } ;
 
-ARTICLE: "circular" "circular"
+ARTICLE: "circular" "Circular sequences"
 "The " { $vocab-link "circular" } " vocabulary implements the " { $link "sequence-protocol" } " to allow an arbitrary start index and wrap-around indexing." $nl
 "Creating a new circular object:"
 { $subsection <circular> }
index 058291d022b00e1a3362f8a19c6464702d1efd95..54fc3aac432261c7dc2e9eab7148d3c5e38a4711 100644 (file)
@@ -64,7 +64,7 @@ HELP: n||-rewrite
      { "quot" quotation } }
 { $description "A macro that reqrites the code to pass " { $snippet "N" } " parameters from the stack to each OR quotation." } ;
 
-ARTICLE: "combinators.short-circuit" "combinators.short-circuit"
+ARTICLE: "combinators.short-circuit" "Short-circuit combinators"
 "The " { $vocab-link "combinators.short-circuit" } " vocabulary stops a computation early once a condition is met." $nl
 "AND combinators:"
 { $subsection 0&& }
index abf3ff0eef7e5da9a135c938d779bd2d72ad9480..34abde15b6f69502d30c96903ddbb03af5116db2 100644 (file)
@@ -27,8 +27,9 @@ 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 && }
 "Generalized OR:"