README.md (1691B)
1 doc-coverage [](https://travis-ci.org/jackfirth/doc-coverage) [](https://coveralls.io/r/jackfirth/doc-coverage) 2 ===================================================== 3 [Documentation](http://pkg-build.racket-lang.org/doc/doc-coverage/index.html) 4 5 A Racket package for inspecting and testing the number of documented exports of a module 6 7 Examining module documentation information: 8 9 ```racket 10 > (module->all-exported-names 'racket/promise) 11 '(force 12 promise-forced? 13 promise-running? 14 promise? 15 delay 16 delay/thread 17 delay/name 18 lazy 19 delay/sync 20 delay/strict 21 delay/idle) 22 > (module->undocumented-exported-names 'racket/match) 23 '(match-...-nesting) 24 ``` 25 26 Testing module documentation coverage 27 28 ```racket 29 > (check-all-documented 'racket/base) 30 -------------------- 31 FAILURE 32 name: check-all-documented 33 location: (unsaved-editor307 30 2 704 35) 34 expression: (check-all-documented 'racket/base) 35 params: (racket/base) 36 37 Module racket/base has 3 undocumented bindings: 38 39 expand-for-clause 40 for-clause-syntax-protect 41 syntax-pattern-variable? 42 -------------------- 43 > (check-documentation-ratio 'racket/match .99) 44 -------------------- 45 FAILURE 46 name: check-documentation-ratio 47 location: (unsaved-editor307 45 2 1113 45) 48 expression: (check-documentation-ratio 'racket/match 0.99) 49 params: (racket/match 0.99) 50 51 Module racket/match does not document at least 99.0% of its bindings, only documents 96.42857142857143% 52 -------------------- 53 ``` 54 55 To install, `run raco pkg install doc-coverage`. Then to use in a module, `(require doc-coverage)`.