fix help lint failures, fix example in words

diff --git a/basis/compiler/tree/builder/builder-docs.factor b/basis/compiler/tree/builder/builder-docs.factor
index 3fa576faf587140ad7a3f308445708129e821b4a..b7ee51834b600128b5e1c6ba76108abd5ab05374 100644 (file)
--- a/basis/compiler/tree/builder/builder-docs.factor
+++ b/basis/compiler/tree/builder/builder-docs.factor
@@ -3,11 +3,11 @@ compiler.tree stack-checker.errors ;
 IN: compiler.tree.builder
 
 HELP: build-tree
-{ $values { "quot/word" { $or quotation word } } { "nodes" "a sequence of nodes" } }
+{ $values { "word/quot" { $or word quotation } } { "nodes" "a sequence of nodes" } }
 { $description "Attempts to construct tree SSA IR from a quotation." }
 { $notes "This is the first stage of the compiler." }
 { $errors "Throws an " { $link inference-error } " if stack effect inference fails." } ;
 
 HELP: build-sub-tree
-{ $values { "#call" #call } { "quot/word" { $or quotation word } } { "nodes" { $maybe "a sequence of nodes" } } }
+{ $values { "#call" #call } { "word/quot" { $or word quotation } } { "nodes/f" { $maybe "a sequence of nodes" } } }
 { $description "Attempts to construct tree SSA IR from a quotation, starting with an initial data stack of values from the call site. Outputs " { $link f } " if stack effect inference fails." } ;

diff --git a/basis/tools/crossref/crossref-docs.factor b/basis/tools/crossref/crossref-docs.factor
index 99d1257f3182e551cb62fb3690d789cf6efe4a57..9108777554262d1266227d0131c53c8436ab08ec 100644 (file)
--- a/basis/tools/crossref/crossref-docs.factor
+++ b/basis/tools/crossref/crossref-docs.factor
@@ -1,5 +1,5 @@
 USING: help.markup help.syntax words definitions prettyprint
-tools.crossref.private math quotations assocs ;
+tools.crossref.private math quotations assocs kernel ;
 IN: tools.crossref
 
 ARTICLE: "tools.crossref" "Definition cross referencing"
@@ -51,7 +51,7 @@ HELP: usage.
 { $examples { $code "\\ reverse usage." } } ;
 
 HELP: quot-uses
-{ $values { "quot" quotation } { "assoc" "an assoc with words as keys" } }
+{ $values { "obj" object } { "assoc" "an assoc with words as keys" } }
 { $description "Outputs a set of words referenced by the quotation and any quotations it contains." } ;
 
 { usage usage. } related-words

diff --git a/core/words/words-docs.factor b/core/words/words-docs.factor
index c1b8c0c2294eda2d46023e60c0abbb2b1a19a7cf..58cc3c4f494556d110f4643b738949bd39dc4e32 100644 (file)
--- a/core/words/words-docs.factor
+++ b/core/words/words-docs.factor
@@ -160,11 +160,13 @@ ABOUT: "words"
 
 HELP: execute ( word -- )
 { $values { "word" word } }
-{ $description "Executes a word." }
+{ $description "Executes a word. Words which call execute must be inlined in order to compile when called from other words." }
 { $examples
-    { $example "USING: kernel io words ;" "IN: scratchpad" ": twice ( word -- ) dup execute execute ;\n: hello ( -- ) \"Hello\" print ;\n\\ hello twice" "Hello\nHello" }
+    { $example "USING: kernel io words ;" "IN: scratchpad" ": twice ( word -- ) dup execute execute ; inline\n: hello ( -- ) \"Hello\" print ;\n\\ hello twice" "Hello\nHello" }
 } ;
 
+{ execute POSTPONE: execute( } related-words
+
 HELP: deferred
 { $class-description "The class of deferred words created by " { $link POSTPONE: DEFER: } "." } ;