Help lint tool
Factor handbook » Developer tools » Help system

Prev:Writing documentation
Next:Tips of the day

The 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.

To run help lint, use one of the following two words:
help-lint ( prefix -- )

help-lint-all ( -- )

Once a help lint run completes, failures can be listed:
:lint-failures ( -- )

Help lint failures are also shown in the UI error list tool.

Help lint performs the following checks:
ensures examples run and produce stated output
ensures $see-also elements don't contain duplicate entries
ensures $vocab-link elements point to modules which actually exist
ensures that $values match the stack effect declaration
ensures that help topics actually render (this catches broken links, improper nesting, etc)