]> gitweb.factorcode.org Git - factor.git/blobdiff - core/effects/effects-docs.factor
improve help by linking to types directly.
[factor.git] / core / effects / effects-docs.factor
index da151991a5d4931b6fabdc4d7c3fb5a190ce3cd2..f514c4716405355fabc57374b18c3efe37883f22 100644 (file)
@@ -1,4 +1,5 @@
-USING: arrays classes help.markup help.syntax math strings words kernel combinators sequences ;
+USING: arrays classes help.markup help.syntax kernel math
+sequences strings words ;
 IN: effects
 
 ARTICLE: "effects" "Stack effect declarations"
@@ -124,11 +125,11 @@ HELP: effect-height
 { $description "Outputs the number of objects added to the data stack by the stack effect. This will be negative if the stack effect only removes objects from the stack." } ;
 
 HELP: effect<=
-{ $values { "effect1" effect } { "effect2" effect } { "?" "a boolean" } }
+{ $values { "effect1" effect } { "effect2" effect } { "?" boolean } }
 { $description "Tests if " { $snippet "effect1" } " is substitutable for " { $snippet "effect2" } ". What this means is that both stack effects change the stack height by the same amount, the first takes a smaller or equal number of inputs as the second, and either both or neither one terminate execution by throwing an error." } ;
 
 HELP: effect=
-{ $values { "effect1" effect } { "effect2" effect } { "?" "a boolean" } }
+{ $values { "effect1" effect } { "effect2" effect } { "?" boolean } }
 { $description "Tests if " { $snippet "effect1" } " and " { $snippet "effect2" } " represent the same stack transformation, without looking parameter names." }
 { $examples
   { $example "USING: effects prettyprint ;" "( a -- b ) ( x -- y ) effect= ." "t" }