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

Prev:$notes ( element -- )
Next:$errors ( element -- )


Vocabulary
help.markup

Inputs
elementa markup element of the form { string... }


Outputs
None

Word description
Prints a heading followed by a list of input values or variables which are modified by the word being documented.

Examples

{ { $values { "seq" "a mutable sequence" } } { $side-effects "seq" } } print-element



Inputs and outputs
seqa mutable sequence


Side effects
Modifies seq

Definition

: $side-effects ( element -- )
"Side effects" $heading "Modifies " print-element
[ $snippet ] textual-list ;