Adjusted docs-complete to print a different message when there are no docs at all
and ... ummm... documented docs-complete original commit: d3c04ae701ab550364d1b6059c78b17434001e48
This commit is contained in:
parent
585697af05
commit
5f20e27dc1
31
collects/tests/utils/scribblings.scrbl
Normal file
31
collects/tests/utils/scribblings.scrbl
Normal file
|
@ -0,0 +1,31 @@
|
|||
#lang scribble/doc
|
||||
|
||||
@(require scribble/manual
|
||||
(for-label racket))
|
||||
|
||||
@title{Internal Testing Utilities}
|
||||
|
||||
@section{Checking documentation completeness}
|
||||
@defmodule[tests/utils/docs-complete]
|
||||
|
||||
@defproc[(check-docs [lib symbol?]
|
||||
[#:skip skip
|
||||
(or/c regexp?
|
||||
symbol?
|
||||
(listof (or/c regexp? symbol?))
|
||||
(-> symbol? any)
|
||||
#f)
|
||||
#f])
|
||||
any]{
|
||||
|
||||
Checks to see if the module path named by @racket[lib] (e.g. @racket['racket/list])
|
||||
has documented all of its exports and prints an error message to
|
||||
@racket[(current-error-port)] if not.
|
||||
|
||||
If @racket[skip] is a regexp, then exporting matching that regexp
|
||||
are ignored. If it is a symbol, then that export is ignored. If
|
||||
it is a list of symbols and regexps, then any exporting matching any of the
|
||||
symbols or regexps are ignored. If it is a function, the function is treated
|
||||
as a predicate and passed each export of the module. If @racket[skip] is
|
||||
@racket[#f], no exports are skipped.
|
||||
}
|
Loading…
Reference in New Issue
Block a user