Docs/clarification request

danmayer / coverband

Ruby production code coverage collection and reporting (line of code usage)

https://github.com/danmayer/coverband

MIT License

2.46k stars 157 forks source link

Docs/clarification request #521

Closed trivett closed 5 months ago

trivett commented 5 months ago

As a new user of Coverband, I would like some clarification regarding how to read the data in the UI.

What I would like to see (and I would be happy to contribute to docs if possible) is a little more color to what the various bits information that Coverband surfaces. Perhaps a definition of what "% covered", "% runtime", "lines", "relevant lines", "lines covered", "lines runtime" "average hits /line" mean in detail.

mercedesb commented 5 months ago

@trivett I have no connection to this repo, but stumbled across this issue. This closed issue may answer your questions

trivett commented 5 months ago

@mercedesb Perfect, thank you so much! I might make a PR to make this easier to find.