basis/help/lint/lint-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: help.lint
   3
   4 HELP: help-lint-all
   5 { $description "Checks all word help and articles in all loaded vocabularies." } ;
   6
   7 HELP: help-lint
   8 { $values { "prefix" "a vocabulary specifier" } }
   9 { $description "Checks all word help and articles in the given vocabulary and all child vocabularies." } ;
  10
  11 ARTICLE: "help.lint" "Help lint tool"
  12 "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."
  13 $nl
  14 "To run help lint, use one of the following two words:"
  15 { $subsection help-lint }
  16 { $subsection help-lint-all }
  17 "Help lint performs the following checks:"
  18 { $list
  19     "ensures examples run and produce stated output"
  20     { "ensures " { $link $see-also } " elements don't contain duplicate entries" }
  21     { "ensures " { $link $vocab-link } " elements point to modules which actually exist" }
  22     { "ensures that " { $link $values } " match the stack effect declaration" }
  23     { "ensures that help topics actually render (this catches broken links, improper nesting, etc)" }
  24 } ;
  25
  26 ABOUT: "help.lint"