Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Kover documentation #282

Closed
shanshin opened this issue Nov 22, 2022 · 0 comments · Fixed by #382
Closed

Improve Kover documentation #282

shanshin opened this issue Nov 22, 2022 · 0 comments · Fixed by #382
Assignees
Labels
Documentation Feature Feature request issue type S: in progress Status: implementing or design in process

Comments

@shanshin
Copy link
Collaborator

Proposed changes:

  • add a detailed description of the Kotlin Kover: purpose, differences, pros and cons.
  • explicitly mention example projects
  • improve the description of the minimum setup for the ”quick start”
  • explain the difference between Kotlin/Groovy code snippets in more detail
  • add the requirement to enable Kover in all modules in the description
  • merge “Single-project tasks” with “Configuring project” and “Cross-project coverage with Configuring merged reports”
  • describe the difference between kover{} and kovermerged{}
  • add a Kover HTML report description
    • when reading the report - some of the lines are green and some are red. It’s quite straightforward - they’re either fully tested or not at all. But the yellow ones are a bit unclear
    • explicitly indicate that the report only shows coverage by lines, it cannot provide detailed information on each expression in a line
@shanshin shanshin added Feature Feature request issue type S: untriaged Status: issue reported but unprocessed Documentation labels Nov 22, 2022
@shanshin shanshin self-assigned this Nov 22, 2022
@shanshin shanshin added S: in progress Status: implementing or design in process and removed S: untriaged Status: issue reported but unprocessed labels May 22, 2023
shanshin added a commit that referenced this issue May 24, 2023
shanshin added a commit that referenced this issue Jun 1, 2023
Resolves #282

PR #382

Co-authored-by: Leonid Startsev <sandwwraith@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Feature Feature request issue type S: in progress Status: implementing or design in process
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant