]> gitweb.factorcode.org Git - factor.git/commitdiff
stack-checker.*: misc doc additions
authorBjörn Lindqvist <bjourne@gmail.com>
Thu, 5 Feb 2015 10:36:44 +0000 (10:36 +0000)
committerBjörn Lindqvist <bjourne@gmail.com>
Thu, 5 Feb 2015 11:01:05 +0000 (11:01 +0000)
basis/stack-checker/branches/branches-docs.factor [new file with mode: 0644]
basis/stack-checker/recursive-state/recursive-state-docs.factor [new file with mode: 0644]
basis/stack-checker/visitor/visitor-docs.factor

diff --git a/basis/stack-checker/branches/branches-docs.factor b/basis/stack-checker/branches/branches-docs.factor
new file mode 100644 (file)
index 0000000..db93393
--- /dev/null
@@ -0,0 +1,6 @@
+USING: assocs help.markup help.syntax ;
+IN: stack-checker.branches
+
+HELP: collect-variables
+{ $values { "hash" assoc } }
+{ $description "Gathers all variables used during inferencing into a hash." } ;
diff --git a/basis/stack-checker/recursive-state/recursive-state-docs.factor b/basis/stack-checker/recursive-state/recursive-state-docs.factor
new file mode 100644 (file)
index 0000000..3182ed2
--- /dev/null
@@ -0,0 +1,6 @@
+USING: compiler.tree effects help.markup help.syntax math quotations ;
+IN: stack-checker.recursive-state
+
+HELP: recursive-quotation?
+{ $values { "quot" quotation } }
+{ $description "Checks if the quotation is among the registered recursive quotations." } ;
index 4805d4edae11be2215a166778d4776103a46653b..3a63af0bae7513c2043737f96409d2d3c6840e49 100644 (file)
@@ -11,3 +11,7 @@ HELP: #>r,
     "V{\n    T{ #shuffle\n        { mapping { { 124 123 } } }\n        { in-d { 123 } }\n        { out-r { 124 } }\n    }\n}"
   }
 } ;
+
+HELP: #drop,
+{ $values { "values" sequence } }
+{ $class-description "Outputs a " { $link #shuffle } " instruction which drops one or more values from the data stack." } ;