]> gitweb.factorcode.org Git - factor.git/commitdiff
make: update docs for 'make-assoc' functionality.
authorJohn Benediktsson <mrjbq7@gmail.com>
Thu, 2 Aug 2012 16:32:18 +0000 (09:32 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Thu, 2 Aug 2012 16:32:18 +0000 (09:32 -0700)
core/make/make-docs.factor

index dfe23e0d1507fc3114ba7ebe73fa3030b99f2509..ff33790b558471af2f8452c9d185d4dbea4065b1 100644 (file)
@@ -37,9 +37,9 @@ $nl
 { $code "'[ 2 _ + ]" } ;
 
 ARTICLE: "namespaces-make" "Making sequences with variables"
-"The " { $vocab-link "make" } " vocabulary implements a facility for constructing sequences by holding a collector sequence in a variable. Storing the collector sequence in a variable rather than the stack may allow code to be written with less stack manipulation."
+"The " { $vocab-link "make" } " vocabulary implements a facility for constructing " { $link sequence } "s and " { $link assoc } "s by holding a collector object in a variable. Storing the collector object in a variable rather than the stack may allow code to be written with less stack manipulation."
 $nl
-"Sequence construction is wrapped in a combinator:"
+"Object construction is wrapped in a combinator:"
 { $subsections make }
 "Inside the quotation passed to " { $link make } ", several words accumulate values:"
 { $subsections
@@ -47,7 +47,12 @@ $nl
     %
     #
 }
-"The collector sequence can be accessed directly from inside a " { $link make } ":"
+"When making an " { $link assoc } ", you can use these words to add key/value pairs:"
+{ $subsections
+    ,,
+    %%
+}
+"The collector object can be accessed directly from inside a " { $link make } ":"
 { $subsections building }
 { $example
   "USING: make math.parser ;"
@@ -59,12 +64,15 @@ $nl
 ABOUT: "namespaces-make"
 
 HELP: building
-{ $var-description "Temporary mutable growable sequence holding elements accumulated so far by " { $link make } "." } ;
+{ $var-description "Temporary mutable growable sequence (or assoc) holding elements accumulated so far by " { $link make } "." } ;
 
 HELP: make
 { $values { "quot" quotation } { "exemplar" sequence } { "seq" "a new sequence" } }
-{ $description "Calls the quotation in a new dynamic scope with the " { $link building } " variable bound to a new resizable mutable sequence. The quotation and any words it calls can execute the " { $link , } " and " { $link % } " words to accumulate elements. When the quotation returns, all accumulated elements are collected into a sequence with the same type as " { $snippet "exemplar" } "." }
-{ $examples { $example "USING: make prettyprint ;" "[ 1 , 2 , 3 , ] { } make ." "{ 1 2 3 }" } } ;
+{ $description "Calls the quotation in a new dynamic scope with the " { $link building } " variable bound to a new resizable mutable sequence. The quotation and any words it calls can execute the " { $link , } " and " { $link % } " words to accumulate elements into a sequence (or " { $link ,, } " and " { $link %% } " into an assoc). When the quotation returns, all accumulated elements are collected into an object with the same type as " { $snippet "exemplar" } "." }
+{ $examples
+    { $example "USING: make prettyprint ;" "[ 1 , 2 , 3 , ] { } make ." "{ 1 2 3 }" }
+    { $example "USING: make prettyprint ;" "[ 2 1 ,, 4 3 ,, ] H{ } make ." "H{ { 1 2 } { 3 4 } }" }
+} ;
 
 HELP: ,
 { $values { "elt" object } }