]> gitweb.factorcode.org Git - factor.git/commitdiff
macros: Fix docs to show macros output a quot.
authorDoug Coleman <doug.coleman@gmail.com>
Fri, 17 Jul 2015 08:54:35 +0000 (01:54 -0700)
committerDoug Coleman <doug.coleman@gmail.com>
Fri, 17 Jul 2015 08:54:35 +0000 (01:54 -0700)
basis/macros/macros-docs.factor

index 91aa2fa3e514aef6cdae45ba1e9d3ea6ce3d27da..8bc58fb2eff3245f4aca5791c9fd5c3f73bd0995 100644 (file)
@@ -3,7 +3,7 @@ stack-checker.transforms sequences combinators ;
 IN: macros
 
 HELP: MACRO:
-{ $syntax "MACRO: word ( inputs... -- ) definition... ;" }
+{ $syntax "MACRO: word ( inputs... -- quot ) definition... ;" }
 { $description "Defines a macro word. The definition must have stack effect " { $snippet "( inputs... -- quot )" } "." }
 { $notes
   "A call of a macro inside a word definition is replaced with the quotation expansion at compile-time. The following two conditions must hold:"
@@ -17,7 +17,7 @@ HELP: MACRO:
   "A macro that calls a quotation but preserves any values it consumes off the stack:"
   { $code
     "USING: fry generalizations kernel macros stack-checker ;"
-    "MACRO: preserving ( quot -- )"
+    "MACRO: preserving ( quot -- quot' )"
     "    [ inputs ] keep '[ _ ndup @ ] ;"
   }
   "Using this macro, we can define a variant of " { $link if } " which takes a predicate quotation instead of a boolean; any values consumed by the predicate quotation are restored immediately after:"