]> gitweb.factorcode.org Git - factor.git/commitdiff
combinators.tuples: fix docs for 1make-tuple.
authorJohn Benediktsson <mrjbq7@gmail.com>
Wed, 4 Nov 2020 19:07:03 +0000 (11:07 -0800)
committerJohn Benediktsson <mrjbq7@gmail.com>
Wed, 4 Nov 2020 19:07:03 +0000 (11:07 -0800)
extra/combinators/tuple/tuple-docs.factor

index bcf488687f794bb442d69c7c45e95e8470f08dc0..48bf780e666f2b2fb963e8d74f6caf7e552ac2a1 100644 (file)
@@ -4,21 +4,7 @@ USING: assocs classes help.markup help.syntax kernel math
 quotations strings ;
 IN: combinators.tuple
 
-HELP: 2make-tuple
-{ $values
-    { "x" object } { "y" object } { "class" class } { "assoc" assoc }
-    { "tuple" tuple }
-}
-{ $description "Constructs a " { $link tuple } " of " { $snippet "class" } " by calling the quotations making up the values of " { $snippet "assoc" } " on " { $snippet "x" } " and " { $snippet "y" } ", assigning the result of each call to the slot named by the corresponding key. The quotations must have the effect " { $snippet "( x y -- slot-value )" } ". The order in which the quotations are called is undefined." } ;
-
-HELP: 3make-tuple
-{ $values
-    { "x" object } { "y" object } { "z" object } { "class" class } { "assoc" "a list of " { $link string } "/" { $link quotation } " pairs" }
-    { "tuple" tuple }
-}
-{ $description "Constructs a " { $link tuple } " of " { $snippet "class" } " by calling the quotations making up the values of " { $snippet "assoc" } " on " { $snippet "x" } ", " { $snippet "y" } ", and " { $snippet "z" } ", assigning the result of each call to the slot named by the corresponding key. The quotations must have the effect " { $snippet "( x y z -- slot-value )" } ". The order in which the quotations are called is undefined." } ;
-
-HELP: make-tuple
+HELP: 1make-tuple
 { $values
     { "x" object } { "class" class } { "assoc" "a list of " { $link string } "/" { $link quotation } " pairs" }
     { "tuple" tuple }
@@ -32,23 +18,37 @@ HELP: make-tuple
         "5 demo {"
         "   { \"x\" [ 10 + ] }"
         "   { \"y\" [ 100 / ] }"
-        "} make-tuple ."
+        "} 1make-tuple ."
         "T{ demo { x 15 } { y 1/20 } }"
     }
 } ;
 
+HELP: 2make-tuple
+{ $values
+    { "x" object } { "y" object } { "class" class } { "assoc" assoc }
+    { "tuple" tuple }
+}
+{ $description "Constructs a " { $link tuple } " of " { $snippet "class" } " by calling the quotations making up the values of " { $snippet "assoc" } " on " { $snippet "x" } " and " { $snippet "y" } ", assigning the result of each call to the slot named by the corresponding key. The quotations must have the effect " { $snippet "( x y -- slot-value )" } ". The order in which the quotations are called is undefined." } ;
+
+HELP: 3make-tuple
+{ $values
+    { "x" object } { "y" object } { "z" object } { "class" class } { "assoc" "a list of " { $link string } "/" { $link quotation } " pairs" }
+    { "tuple" tuple }
+}
+{ $description "Constructs a " { $link tuple } " of " { $snippet "class" } " by calling the quotations making up the values of " { $snippet "assoc" } " on " { $snippet "x" } ", " { $snippet "y" } ", and " { $snippet "z" } ", assigning the result of each call to the slot named by the corresponding key. The quotations must have the effect " { $snippet "( x y z -- slot-value )" } ". The order in which the quotations are called is undefined." } ;
+
 HELP: nmake-tuple
 { $values
     { "class" class } { "assoc" "a list of " { $link string } "/" { $link quotation } " pairs" } { "n" integer }
 }
 { $description "Constructs a " { $link tuple } " of " { $snippet "class" } " by calling the quotations making up the values of " { $snippet "assoc" } " on the top " { $snippet "n" } " values on the datastack below " { $snippet "class" } ", assigning the result of each call to the slot named by the corresponding key. The order in which the quotations are called is undefined." } ;
 
-{ make-tuple 2make-tuple 3make-tuple nmake-tuple } related-words
+{ 1make-tuple 2make-tuple 3make-tuple nmake-tuple } related-words
 
 ARTICLE: "combinators.tuple" "Tuple-constructing combinators"
 "The " { $vocab-link "combinators.tuple" } " vocabulary provides combinators that construct " { $link tuple } " objects. These provide additional functionality above and beyond built-in " { $link "tuple-constructors" } "."
 { $subsections
-    make-tuple
+    1make-tuple
     2make-tuple
     3make-tuple
     nmake-tuple