$values ( element -- ) - Factor Documentation

$values ( element -- )
Factor handbook » Developer tools » Help system » Writing documentation » Element types » Block elements

Prev:	$nl ( children -- )
Next:	$description ( element -- )

Vocabulary
help.markup

Inputs

element

an array of pairs of markup elements

Outputs
None

Word description
Prints the description of arguments and values found on every word help page. The first element of a pair is the argument name and is output with $snippet. The remainder is either a single class word, or an element. If it is a class word class, it is inserted as if it were shorthand for { $instance class }.

See also
$maybe, $instance, $quotation

Definition

IN: help.markup

: $values ( element -- )
"Inputs and outputs" $heading ($values) ;