Dover: Documentation Coverage🔗ℹ

Racket has an amazing documentation system in Scribble, and if you’re making Racket packages, you should use it.

Dover checks a set of one or more packages and scores them on how many of their exported bindings have Scribble documentation. Use it from the command line while you write docs, or in CI to keep coverage from slipping.

Installation:

  raco pkg install dover

To use:

  raco dover check ‹options› ‹pkg› ...

Dover reads the documentation that is already installed, so a package’s docs must be built (normally by raco pkg install or raco setup) before Dover can see them.

The canonical copy of this documentation is at https://joeldueck.com/what-about/dover.