Fix docs
parent
1dd3ed519f
commit
8432c30ed1
|
@ -182,12 +182,14 @@ HELP: either?
|
|||
|
||||
HELP: call
|
||||
{ $values { "callable" callable } }
|
||||
{ $description "Calls a quotation." }
|
||||
{ $description "Calls a quotation. Words which " { $link call } " an input parameter must be declared " { $link POSTPONE: inline } " so that a caller which passes in a literal quotation can have a static stack effect." }
|
||||
{ $examples
|
||||
"The following two lines are equivalent:"
|
||||
{ $code "2 [ 2 + 3 * ] call" "2 2 + 3 *" }
|
||||
} ;
|
||||
|
||||
{ call POSTPONE: call( } related-words
|
||||
|
||||
HELP: call-clear ( quot -- )
|
||||
{ $values { "quot" callable } }
|
||||
{ $description "Calls a quotation with an empty call stack. If the quotation returns, Factor will exit.." }
|
||||
|
|
|
@ -791,7 +791,14 @@ HELP: call-next-method
|
|||
|
||||
HELP: call(
|
||||
{ $syntax "call( stack -- effect )" }
|
||||
{ $description "Calls the quotation on the top of the stack, asserting that it has the given stack effect. The quotation does not need to be known at compile time." } ;
|
||||
{ $description "Calls the quotation on the top of the stack, asserting that it has the given stack effect. The quotation does not need to be known at compile time." }
|
||||
{ $examples
|
||||
{ $code
|
||||
"TUPLE: action name quot ;"
|
||||
": perform-action ( action -- )"
|
||||
" [ name>> print ] [ quot>> call( -- ) ] bi ;"
|
||||
}
|
||||
} ;
|
||||
|
||||
HELP: execute(
|
||||
{ $syntax "execute( stack -- effect )" }
|
||||
|
|
|
@ -160,7 +160,7 @@ ABOUT: "words"
|
|||
|
||||
HELP: execute ( word -- )
|
||||
{ $values { "word" word } }
|
||||
{ $description "Executes a word. Words which call execute must be inlined in order to compile when called from other words." }
|
||||
{ $description "Executes a word. Words which " { $link execute } " an input parameter must be declared " { $link POSTPONE: inline } " so that a caller which passes in a literal word can have a static stack effect." }
|
||||
{ $examples
|
||||
{ $example "USING: kernel io words ;" "IN: scratchpad" ": twice ( word -- ) dup execute execute ; inline\n: hello ( -- ) \"Hello\" print ;\n\\ hello twice" "Hello\nHello" }
|
||||
} ;
|
||||
|
|
Loading…
Reference in New Issue