related-words ( seq -- )
Factor handbook » Developer tools » Help system » Writing documentation

Prev:

Printing markup elements

Vocabulary
help.markup

Inputs

seq	a sequence of words

Outputs
None

Word description
Defines a set of related words. Each word's documentation will contain links to all other words in the set. Duplicate words are ignored, and words are not related to themselves. This replaces existing relations for the words in the set, removing obsolete reciprocal links.

See also
$related

Definition

USING: help.markup.private kernel sets ;

IN: help.markup

: related-words ( seq -- )
    members dup update-related-words
    [ clear-unrelated-words ] [ notify-related-words ] bi ;