Better docs for generalizations

basis/generalizations/generalizations-docs.factor

@@ -17,6 +17,15 @@ HELP: narray
 { $description "A generalization of " { $link 1array } ", "
 { $link 2array } ", " { $link 3array } " and " { $link 4array } " "
 "that constructs an array from the top " { $snippet "n" } " elements of the stack."
+}
+{ $examples
+    "Some core words expressed in terms of " { $link narray } ":"
+    { $table
+        { { $link 1array } { $snippet "1 narray" } }
+        { { $link 2array } { $snippet "2 narray" } }
+        { { $link 3array } { $snippet "3 narray" } }
+        { { $link 4array } { $snippet "4 narray" } }
+    }
 } ;
 
 { nsequence narray } related-words
@@ -26,6 +35,15 @@ HELP: firstn
 { $description "A generalization of " { $link first } ", "
 { $link first2 } ", " { $link first3 } " and " { $link first4 } " "
 "that pushes the first " { $snippet "n" } " elements of a sequence on the stack."
+}
+{ $examples
+    "Some core words expressed in terms of " { $link firstn } ":"
+    { $table
+        { { $link first } { $snippet "1 firstn" } }
+        { { $link first2 } { $snippet "2 firstn" } }
+        { { $link first3 } { $snippet "3 firstn" } }
+        { { $link first4 } { $snippet "4 firstn" } }
+    }
 } ;
 
 HELP: npick
@@ -37,8 +55,13 @@ HELP: npick
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 4 npick .s" "1\n2\n3\n4\n1" }
-}
+  "Some core words expressed in terms of " { $link npick } ":"
-{ $see-also dup over pick } ;
+    { $table
+        { { $link dup } { $snippet "1 npick" } }
+        { { $link over } { $snippet "2 npick" } }
+        { { $link pick } { $snippet "3 npick" } }
+    }
+} ;
 
 HELP: ndup
 { $values { "n" integer } }
@@ -49,8 +72,13 @@ HELP: ndup
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 4 ndup .s" "1\n2\n3\n4\n1\n2\n3\n4" }
-}
+  "Some core words expressed in terms of " { $link ndup } ":"
-{ $see-also dup 2dup 3dup } ;
+    { $table
+        { { $link dup } { $snippet "1 ndup" } }
+        { { $link 2dup } { $snippet "2 ndup" } }
+        { { $link 3dup } { $snippet "3 ndup" } }
+    }
+} ;
 
 HELP: nnip
 { $values { "n" integer } }
@@ -60,8 +88,12 @@ HELP: nnip
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 3 nnip .s" "4" }
-}
+  "Some core words expressed in terms of " { $link nnip } ":"
-{ $see-also nip 2nip } ;
+    { $table
+        { { $link nip } { $snippet "1 nnip" } }
+        { { $link 2nip } { $snippet "2 nnip" } }
+    }
+} ;
 
 HELP: ndrop
 { $values { "n" integer } }
@@ -71,8 +103,13 @@ HELP: ndrop
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 3 ndrop .s" "1" }
-}
+  "Some core words expressed in terms of " { $link ndrop } ":"
-{ $see-also drop 2drop 3drop } ;
+    { $table
+        { { $link drop } { $snippet "1 ndrop" } }
+        { { $link 2drop } { $snippet "2 ndrop" } }
+        { { $link 3drop } { $snippet "3 ndrop" } }
+    }
+} ;
 
 HELP: nrot
 { $values { "n" integer } }
@@ -81,8 +118,12 @@ HELP: nrot
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 4 nrot .s" "2\n3\n4\n1" }
-}
+  "Some core words expressed in terms of " { $link nrot } ":"
-{ $see-also rot -nrot } ;
+    { $table
+        { { $link swap } { $snippet "1 nrot" } }
+        { { $link rot } { $snippet "2 nrot" } }
+    }
+} ;
 
 HELP: -nrot
 { $values { "n" integer } }
@@ -91,8 +132,12 @@ HELP: -nrot
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 4 -nrot .s" "4\n1\n2\n3" }
-}
+  "Some core words expressed in terms of " { $link -nrot } ":"
-{ $see-also rot nrot } ;
+    { $table
+        { { $link swap } { $snippet "1 -nrot" } }
+        { { $link -rot } { $snippet "2 -nrot" } }
+    }
+} ;
 
 HELP: nrev
 { $values { "n" integer } }
@@ -100,11 +145,11 @@ HELP: nrev
 }
 { $examples
   { $example "USING: prettyprint generalizations ;" "1 2 3 4 4 nrev .s" "4\n3\n2\n1" }
-}
+  "The " { $link spin } " word is equivalent to " { $snippet "3 nrev" } "."
-{ $see-also rot nrot } ;
+} ;
 
 HELP: ndip
-{ $values { "quot" quotation } { "n" number } }
+{ $values { "quot" quotation } { "n" integer } }
 { $description "A generalization of " { $link dip } " that can work " 
 "for any stack depth. The quotation will be called with a stack that "
 "has 'n' items removed first. The 'n' items are then put back on the "
@@ -113,30 +158,93 @@ HELP: ndip
 { $examples
   { $example "USING: generalizations kernel prettyprint ;" "1 2 [ dup ] 1 ndip .s" "1\n1\n2" }
   { $example "USING: generalizations kernel prettyprint ;" "1 2 3 [ drop ] 2 ndip .s" "2\n3" }
-}
+  "Some core words expressed in terms of " { $link ndip } ":"
-{ $see-also dip 2dip } ;
+    { $table
+        { { $link dip } { $snippet "1 ndip" } }
+        { { $link 2dip } { $snippet "2 ndip" } }
+        { { $link 3dip } { $snippet "3 ndip" } }
+    }
+} ;
 
 HELP: nslip
-{ $values { "n" number } }
+{ $values { "n" integer } }
 { $description "A generalization of " { $link slip } " that can work " 
 "for any stack depth. The first " { $snippet "n" } " items after the quotation will be "
 "removed from the stack, the quotation called, and the items restored."
 } 
 { $examples
   { $example "USING: generalizations prettyprint ;" "[ 99 ] 1 2 3 4 5 5 nslip .s" "99\n1\n2\n3\n4\n5" }
-}
+  "Some core words expressed in terms of " { $link nslip } ":"
-{ $see-also slip nkeep } ;
+    { $table
+        { { $link slip } { $snippet "1 nslip" } }
+        { { $link 2slip } { $snippet "2 nslip" } }
+        { { $link 3slip } { $snippet "3 nslip" } }
+    }
+} ;
 
 HELP: nkeep
-{ $values { "quot" quotation } { "n" number } }
+{ $values { "quot" quotation } { "n" integer } }
 { $description "A generalization of " { $link keep } " that can work " 
 "for any stack depth. The first " { $snippet "n" } " items after the quotation will be "
 "saved, the quotation called, and the items restored."
 } 
 { $examples
   { $example "USING: generalizations kernel prettyprint ;" "1 2 3 4 5 [ drop drop drop drop drop 99 ] 5 nkeep .s" "99\n1\n2\n3\n4\n5" }
-}
+  "Some core words expressed in terms of " { $link nkeep } ":"
-{ $see-also keep nslip } ;
+    { $table
+        { { $link keep } { $snippet "1 nkeep" } }
+        { { $link 2keep } { $snippet "2 nkeep" } }
+        { { $link 3keep } { $snippet "3 nkeep" } }
+    }
+} ;
+
+HELP: ncurry
+{ $values { "quot" quotation } { "n" integer } }
+{ $description "A generalization of " { $link curry } " that can work for any stack depth."
+} 
+{ $examples
+  "Some core words expressed in terms of " { $link ncurry } ":"
+    { $table
+        { { $link curry } { $snippet "1 ncurry" } }
+        { { $link 2curry } { $snippet "2 ncurry" } }
+        { { $link 3curry } { $snippet "3 ncurry" } }
+    }
+} ;
+
+HELP: nwith
+{ $values { "quot" quotation } { "n" integer } }
+{ $description "A generalization of " { $link with } " that can work for any stack depth."
+} 
+{ $examples
+  "Some core words expressed in terms of " { $link nwith } ":"
+    { $table
+        { { $link with } { $snippet "1 nwith" } }
+    }
+} ;
+
+HELP: napply
+{ $values { "quot" quotation } { "n" integer } }
+{ $description "A generalization of " { $link bi@ } " and " { $link tri@ } " that can work for any stack depth."
+} 
+{ $examples
+  "Some core words expressed in terms of " { $link napply } ":"
+    { $table
+        { { $link bi@ } { $snippet "1 napply" } }
+        { { $link tri@ } { $snippet "2 napply" } }
+    }
+} ;
+
+HELP: mnswap
+{ $values { "m" integer } { "n" integer } }
+{ $description "Swaps the top " { $snippet "m" } " stack elements with the " { $snippet "n" } " elements directly underneath." }
+{ $examples
+  "Some core words expressed in terms of " { $link mnswap } ":"
+    { $table
+        { { $link swap } { $snippet "1 1 mnswap" } }
+        { { $link rot } { $snippet "2 1 mnswap" } }
+        { { $link -rot } { $snippet "1 2 mnswap" } }
+    }
+} ;
 
 ARTICLE: "generalizations" "Generalized shuffle words and combinators"
 "The " { $vocab-link "generalizations" } " vocabulary defines a number of stack shuffling words and combinators for use in "
@@ -155,12 +263,14 @@ $nl
 { $subsection nnip }
 { $subsection ndrop }
 { $subsection nrev }
+{ $subsection mnswap }
 "Generalized combinators:"
 { $subsection ndip }
 { $subsection nslip }
 { $subsection nkeep }
+{ $subsection napply }
+"Generalized quotation construction:"
 { $subsection ncurry } 
-{ $subsection nwith } 
+{ $subsection nwith } ;
-{ $subsection napply } ;
 
 ABOUT: "generalizations"

basis/generalizations/generalizations.factor

@@ -13,14 +13,14 @@ IN: generalizations
 
 >>
 
-MACRO: nsequence ( n seq -- quot )
+MACRO: nsequence ( n seq -- )
     [
         [ drop <reversed> ] [ '[ _ _ new-sequence ] ] 2bi
         [ '[ @ [ _ swap set-nth-unsafe ] keep ] ] reduce
     ] keep
     '[ @ _ like ] ;
 
-MACRO: narray ( n -- quot )
+MACRO: narray ( n -- )
     '[ _ { } nsequence ] ;
 
 MACRO: firstn ( n -- )
@@ -30,7 +30,7 @@ MACRO: firstn ( n -- )
         bi prefix '[ _ cleave ]
     ] if ;
 
-MACRO: npick ( n -- quot )
+MACRO: npick ( n -- )
     1- [ dup ] [ '[ _ dip swap ] ] repeat ;
 
 MACRO: ndup ( n -- )
@@ -51,7 +51,7 @@ MACRO: nnip ( n -- )
 MACRO: ntuck ( n -- )
     2 + '[ dup _ -nrot ] ;
 
-MACRO: nrev ( n -- quot )
+MACRO: nrev ( n -- )
     1 [a,b] [ ] [ '[ @ _ -nrot ] ] reduce ;
 
 MACRO: ndip ( quot n -- )