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

Prev:	$var-description ( element -- )
Next:	$examples ( element -- )

Vocabulary
help.markup

Inputs

element

a markup element

Outputs
None

Word description
Prints a heading followed by a contract, found on the help page of generic words. Every generic word should document a contract which specifies method behavior that callers can rely upon, and implementations must obey.

Examples

{ $contract "Methods of this generic word must always crash." } print-element

Generic word contract
Methods of this generic word must always crash.

Definition

IN: help.markup

: $contract ( element -- )
    "Generic word contract" $heading print-element ;