HELP:
Factor handbook » Developer tools » Help system » Writing documentation

Prev:	ARTICLE:
Next:	ABOUT:

Vocabulary
help.syntax

Syntax

HELP: word content... ;

Inputs
None

Outputs
None

Word description
Defines documentation for a word.

Examples

USING: help help.markup help.syntax math ; : foo ( m -- n ) 2 + ; HELP: foo { $values { "m" integer } { "n" integer } } { $description "Increments a value by 2." } ; \ foo help

Definition

USING: help help.topics kernel parser vocabs.parser words ;

IN: help.syntax

SYNTAX: HELP:
    H{ { "{" POSTPONE: HELP{ } } [
        scan-word bootstrap-word
        [ >link save-location ]
        [ [ parse-array-def ] dip set-word-help ] bi
    ] with-words ;

This documentation was generated offline from a load-all image. If you want, you can also browse the documentation from within the UI developer tools. See the Factor website for more information.

Factor 0.99 x86.64 (2168, heads/master-c0150244ae, Jun 20 2022 14:04:16)