2007-09-20 18:09:08 -04:00
USING: help.markup help.syntax ;
IN: help.lint
2007-12-11 22:36:40 -05:00
HELP: check-help
{ $description "Checks all word and article help." } ;
HELP: check-vocab-help
{ $values { "vocab" "a vocabulary specifier" } }
{ $description "Checks all word help in the given vocabulary." } ;
2007-09-20 18:09:08 -04:00
ARTICLE: "help.lint" "Help lint tool"
2007-12-11 22:36:40 -05:00
"The " { $vocab-link "help.lint" } " vocabulary implements a tool to check documentation in an automated fashion. You should use this tool to check any documentation that you write."
$nl
"To run help lint, use one of the following two words:"
{ $subsection check-help }
{ $subsection check-vocab-help }
"Help lint performs the following checks:"
2007-09-20 18:09:08 -04:00
{ $list
"ensures examples run and produce stated output"
{ "ensures " { $link $see-also } " elements don't contain duplicate entries" }
{ "ensures " { $link $vocab-link } " elements point to modules which actually exist" }
{ "ensures that " { $link $values } " match the stack effect declaration" }
{ "ensures that word help articles actually render (this catches broken links, improper nesting, etc)" }
} ;
ABOUT: "help.lint"
