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

updating docs

Browse Source
This commit is contained in:
Spencer Florence 2015-01-07 11:00:55 -05:00
parent db9c445729
commit b80d0234e5
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -19,12 +19,8 @@ Right now the valid formats are: `html` and `coveralls`.
highlighted source code.
`coveralls` generates a coveralls coverage report and sends it to coveralls.
Using coveralls requires the "COVERALLS_REPO_TOKEN" to be set, and needs bash and curl.
Travic-ci/Coveralls support coming soon...
Note that coveralls expect coverage by line. To convert from an expression based coverage to line based coverage we consider any line with any unrun expression to be not run.
The directory that the coverage is outputted to can be specified with the `-d` flag.
For more detailed usage see [the full documentation](http://pkg-build.racket-lang.org/doc/cover/index.html).
If any tests run by `rackunit` fail, Cover will return with exit code `1`. If all tests pass it will return with exit code `0`.
@ -55,4 +51,4 @@ Note: This currently only works for public Github repos. This project does not s
## Internals
Cover also comes with a racket API for running tests and generating coverage reports. Documentation coming soon...
Cover comes with a racket API, which can be read about in [the full documentation](http://pkg-build.racket-lang.org/doc/cover/index.html).

5
scribblings/basics.scrbl
View File

@ -27,8 +27,11 @@ The @exec{raco cover} command accepts the following flags:
--- excludes any directories by given name from the coverage report.
Files in these directories are still run, they are just excluded from the
outputted coverage. This flag may appear any number of times.}
@item{@Flag{p} or @DFlag{exclude-pkg-defaults}
Equivalent to @exec{-e tests -e info.rkt -e scribblings}}
@item{@Flag{i} or @DFlag{include-extentions}
--- include the given regular expression in the list of file patterns
used when expanding directories, searching for files to cover.}
@item{@Flag{v} or @DFlag{verbose}
--- enable verbose logging}]
--- enable verbose logging}
]