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

Prev:$contract ( element -- )
Next:$warning ( element -- )


Vocabulary
help.markup

Inputs
elementa markup element


Outputs
None

Word description
Prints a heading followed by some examples. Word documentation should include examples, at least if the usage of the word is not entirely obvious.

Examples

{ $examples { $example "USING: math prettyprint ;" "2 2 + ." "4" } } print-element



Examples

USING: math prettyprint ; 2 2 + .
4



Definition

: $examples ( element -- ) "Examples" $heading print-element ;