suzanne.soy/cover
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed documentation errors

Browse Source
This commit is contained in:
Spencer Florence 2015-10-30 10:53:01 -04:00
parent d226a3cf2f
commit a325081a91
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
cover/scribblings/plugins.scrbl
View File

@ -3,6 +3,8 @@
@title[#:tag "plugin"]{Creating Custom Output Formats}
@bold{Warning:} The API presented here is unstable, and may change without warning.
Any package may add an output format to cover. A format is, roughly, a function that takes
coverage information and transforms it into some other format. To add a format
put a definition for @racket[cover-formats] into a packages @filepath["info.rkt"]. This should be a
@ -13,8 +15,9 @@ put a definition for @racket[cover-formats] into a packages @filepath["info.rkt"
@item{@racket[_module-path] should be the path to a racket file providing this format.}
@item{@@racket[_function-name] should be a symbol that is
bound to a function in @racket[_module-path]. It should match the contract
@racket[(->* (coverage/c) (path-string?) any)], and is the implementation of
the format.}
@racket[(->* (coverage/c (listof any/c)) (path-string?) any)], and is the implementation of
the format. The first argument is the coverage map, the second are the files in the map, and the
third is the directory to put the coverage in.}
}
Output formats should log any ``verbose'' output at the @racket['debug] level to the topic