A Racket package for inspecting and testing the number of documented exports of a module

Go to file

Georges Dupéron 5fb60065b7 Allow specifying a "skip" regexp on the command-line.		2017-04-09 17:24:41 +02:00
doc-coverage	Allow specifying a "skip" regexp on the command-line.	2017-04-09 17:24:41 +02:00
.gitignore	Add raco command.	2015-12-31 12:09:12 -07:00
.travis.yml	install cover and cover-coveralls separately for travis builds	2016-07-04 17:04:24 -04:00
info.rkt	remove dependency on cover, add cover-omit-paths declaration	2016-07-04 17:07:07 -04:00
LICENSE	Create LICENSE	2015-12-29 22:36:05 -08:00
README.md	Update README.md	2015-02-21 11:19:06 -08:00

README.md

doc-coverage

Documentation

A Racket package for inspecting and testing the number of documented exports of a module

Examining module documentation information:

> (module->all-exported-names 'racket/promise)
'(force
  promise-forced?
  promise-running?
  promise?
  delay
  delay/thread
  delay/name
  lazy
  delay/sync
  delay/strict
  delay/idle)
> (module->undocumented-exported-names 'racket/match)
'(match-...-nesting)

Testing module documentation coverage

> (check-all-documented 'racket/base)
--------------------
FAILURE
name:       check-all-documented
location:   (unsaved-editor307 30 2 704 35)
expression: (check-all-documented 'racket/base)
params:     (racket/base)

Module racket/base has 3 undocumented bindings:

expand-for-clause
for-clause-syntax-protect
syntax-pattern-variable?
--------------------
> (check-documentation-ratio 'racket/match .99)
--------------------
FAILURE
name:       check-documentation-ratio
location:   (unsaved-editor307 45 2 1113 45)
expression: (check-documentation-ratio 'racket/match 0.99)
params:     (racket/match 0.99)

Module racket/match does not document at least 99.0% of its bindings, only documents 96.42857142857143%
--------------------

To install, run raco pkg install doc-coverage. Then to use in a module, (require doc-coverage).