]> gitweb.factorcode.org Git - factor.git/commitdiff
variants docs nitpicks
authorJoe Groff <arcata@gmail.com>
Fri, 3 Jul 2009 00:01:50 +0000 (19:01 -0500)
committerJoe Groff <arcata@gmail.com>
Fri, 3 Jul 2009 00:01:50 +0000 (19:01 -0500)
extra/variants/variants-docs.factor

index 8ba1623f2e796be5a9b1897f790f07599ea34b9e..f9b62e11f30c8f5a882b976e0a031f69aee6cd63 100644 (file)
@@ -13,7 +13,7 @@ VARIANT: class-name
     .
     .
     ; "> }
-{ $description "Defines " { $snippet "class-name" } " as a union of the following " { $link singleton-class } " and " { $link tuple-class } " definitions. Each " { $snippet "singleton" } " word is defined as a " { $snippet "singleton-class" } ", and each " { $snippet "tuple" } " word is defined aas a " { $snippet "tuple-class" } " with the given set of " { $snippet "slot" } "s, using the same syntax for slot specifiers as " { $link POSTPONE: TUPLE: } ". Typed tuple slots are able to recursively reference the variant " { $snippet "class-name" } " being defined. For " { $snippet "tuple" } " types, a " { $link boa } " constructor word " { $snippet "<tuple>" } " is defined as well." }
+{ $description "Defines " { $snippet "class-name" } " as a union of the following " { $link singleton-class } " and " { $link tuple-class } " definitions. Each " { $snippet "singleton" } " word is defined as a " { $snippet "singleton-class" } ", and each " { $snippet "tuple" } " word is defined aas a " { $snippet "tuple-class" } " with the given set of " { $snippet "slot" } "s, using the same syntax for slot specifiers as " { $link POSTPONE: TUPLE: } ". Typed tuple slots can recursively reference the variant " { $snippet "class-name" } " being defined. For " { $snippet "tuple" } " types, a " { $link boa } " constructor word " { $snippet "<tuple>" } " is defined as well." }
 { $examples { $code <"
 USING: kernel variants ;
 IN: scratchpad
@@ -26,7 +26,7 @@ VARIANT: list
 
 HELP: match
 { $values { "branches" array } }
-{ $description "Dispatches on the type of the value on the top of the stack. If the type is a " { $link singleton-class } ", the corresponding quotation is called with an empty stack. If the type is a " { $link tuple-class } ", the tuple slots are pushed onto the stack by order of arguments." }
+{ $description "Dispatches on the type of the value on the top of the stack. If the type is a " { $link singleton-class } ", the corresponding quotation is called with the underlying stack unchanged. If the type is a " { $link tuple-class } ", the tuple slots are pushed onto the stack by order of arguments." }
 { $examples { $example <"
 USING: kernel math prettyprint variants ;
 IN: scratchpad