Skip to content

Commit 57d2352

Browse files
committed
Updated readme
1 parent e4c4f5f commit 57d2352

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,27 @@ Now we would get 100% code coverage for passing in the values ("Buddist", 34).
3232
That's why in scoverage we focus on statement coverage, and don't even include line coverage as a metric.
3333
This is a paradigm shift that we hope will take hold.
3434

35+
### Branch Coverage
36+
37+
Branch coverage is very useful to ensure all code paths are covered. Scoverage produces branch coverage metrics
38+
as a percentage of the total branches. Symbols that are deemed as branch statements are:
39+
40+
* If / else statements
41+
* Match statements
42+
* Partial function cases
43+
* Try / catch / finally clauses
44+
3545
### How to use
3646

37-
This project is the base functionality for instrumenting code via a scalac plugin. To actually use scoverage in your
47+
This project is the base module for instrumenting code via a scalac compiler plugin. To use scoverage in your
3848
project you will need to use one of the build plugins:
3949

4050
* [maven-scoverage-plugin](https://github.com/scoverage/maven-scoverage-plugin)
4151
* [sbt-scoverage](https://github.com/scoverage/sbt-scoverage)
4252

4353
### Alternatives
4454

45-
There are still only a few code coverage tools for Scala.
55+
There are still only a few code coverage tools for Scala. Here are two that we know of:
4656

4757
* [SCCT](http://mtkopone.github.io/scct/) - Offers line coverage
4858
* [Jacoco4sbt](https://github.com/sbt/jacoco4sbt) - Instruments bytecode

0 commit comments

Comments
 (0)