From 6165a21d24fb954de40043417be532c8da80d2ea Mon Sep 17 00:00:00 2001 From: Spencer Florence Date: Sun, 11 Jan 2015 15:09:30 -0500 Subject: [PATCH] clarifying docs --- scribblings/api.scrbl | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/scribblings/api.scrbl b/scribblings/api.scrbl index 34c0334..6a37ab7 100644 --- a/scribblings/api.scrbl +++ b/scribblings/api.scrbl @@ -21,13 +21,15 @@ existing coverage info.} @defproc[(get-test-coverage) coverage/c]{Gets the current coverage information.} @defproc[(make-covered? (coverage file-coverage/c) (path path-string?)) (->* (exact-positive-integer?) - (#:byte? boolean?) - (or/c 'yes 'no 'missing)) + (#:byte? boolean?) + (or/c 'yes 'no 'missing)) ]{ Given some location in a file and the coverage information for that file @racket[make-covered?] returns a functions that determines if some @racket[1] indexed character or byte location -in that file is covered. There are three possible results: +in that file is covered. By default it checks character locations. + +There are three possible results: @itemize[@item{@racket['missing] --- The location is not in the coverage information, is in a submodule, or lexes (in the sense of that languages @racket[_color-lexer]) as a comment or whitespace.}