]> gitweb.factorcode.org Git - factor.git/blob - core/tools/modules.facts
ea415bdc7cc46c3e206aed5dcc5f14d1825a2f2e
[factor.git] / core / tools / modules.facts
1 IN: modules
2 USING: help ;
3
4 HELP: test-module
5 { $values { "name" "a module name string" } }
6 { $description "Runs the unit test files associated to the module by a previous call to " { $link provide } " or " { $link POSTPONE: PROVIDE: } "." } ;
7
8 HELP: test-modules
9 { $description "Runs unit test files for all loaded modules." } ;
10
11 HELP: run-module
12 { $values { "name" "a module name string" } }
13 { $description "Runs the main entry point of the module, first loading the module if necessary using " { $link require } ". Entry points can be defined with the " { $link POSTPONE: MAIN: } " word." } ;
14
15 HELP: modules-help
16 { $values { "seq" "a new sequence" } }
17 { $description "Outputs a sequence of help articles which are the main entry points into the documentation of loaded modules. Modules can define documentation entry points with the " { $link +help+ } " key of the association list given in " { $link POSTPONE: PROVIDE: } "." } ;