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

updating documentation

Browse Source
This commit is contained in:
Spencer Florence 2015-01-07 19:55:36 -05:00
parent 2425091c22
commit 729f6ac7db
4 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
main.rkt
View File

@ -3,6 +3,8 @@
"private/raw.rkt" racket/contract)
(provide
(contract-out
[coverage/c contract?]
[file-coverage/c contract?]
[test-files! (->* () () #:rest (listof path-string?) any/c)]
[clear-coverage! (-> any)]
[get-test-coverage (-> coverage/c)]

2
scribblings/api.scrbl
View File

@ -17,7 +17,7 @@ fail. Test coverage info is added to existing coverage info.}
@defproc[(clear-coverage!) any]{Clears all coverage information.}
@defproc[(get-coverage-information) coverage/c]{Gets the current coverage information.}
@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?)

4
scribblings/base.rkt
View File

@ -4,9 +4,9 @@
scribble/eval
scribble/manual
(for-label racket/base cover))
(for-label racket cover))
(provide
(all-from-out scribble/eval
scribble/manual)
(for-label (all-from-out racket/base cover)))
(for-label (all-from-out racket cover)))

4
scribblings/basics.scrbl
View File

@ -19,7 +19,9 @@ The @exec{raco cover} command accepts the following flags:
and submit the report to coveralls using that repo token. It should be
noted that, for the moment, coveralls requires both bash and curl to
run.
This is also suitable for pushing to coveralls from Travis CI.}]}
This is also suitable for pushing to coveralls from Travis CI.}
@item{raw: @racket[write]s the raw output @racket[get-test-coverage] to the
output file.}]}
@item{@Flag{d} or @DFlag{directory}
--- Specifies the directory output the coverage too.