From 729f6ac7db4cf0bb3e0dadb7134ffbd77253f0bf Mon Sep 17 00:00:00 2001 From: Spencer Florence Date: Wed, 7 Jan 2015 19:55:36 -0500 Subject: [PATCH] updating documentation --- main.rkt | 2 ++ scribblings/api.scrbl | 2 +- scribblings/base.rkt | 4 ++-- scribblings/basics.scrbl | 4 +++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/main.rkt b/main.rkt index 6c9b2f7..8a76710 100644 --- a/main.rkt +++ b/main.rkt @@ -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)] diff --git a/scribblings/api.scrbl b/scribblings/api.scrbl index 9ac34af..c5ab750 100644 --- a/scribblings/api.scrbl +++ b/scribblings/api.scrbl @@ -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?) diff --git a/scribblings/base.rkt b/scribblings/base.rkt index bad11dc..400b658 100644 --- a/scribblings/base.rkt +++ b/scribblings/base.rkt @@ -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))) diff --git a/scribblings/basics.scrbl b/scribblings/basics.scrbl index 325efcb..03254a7 100644 --- a/scribblings/basics.scrbl +++ b/scribblings/basics.scrbl @@ -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.