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

Expand coverage report explanation to better understand how coverage and coverage completeness values were calculated #327

Merged
merged 2 commits into from
Jul 22, 2024

Conversation

northwestwitch
Copy link
Member

@northwestwitch northwestwitch commented Jul 15, 2024

Closes #325. I have reasoned that tooltips might be useful on the web report, but would disappear if the report is exported to PDF. This way the explanation id downloaded with the page

Description

Added/Changed/Fixed

  • Expanded the stats explanation on the coverage report

How to test

  • Deploy locally or or stage

Expected outcome

  • New explanation should be shown

Review

  • Tests executed by CR
  • "Merge and deploy" approved by Jakob37

This version is a

  • MAJOR - when you make incompatible API changes
  • MINOR - when you add functionality in a backwards compatible manner
  • PATCH - when you make backwards compatible bug fixes or documentation/instructions

…and coverage completeness values were calculated
@northwestwitch northwestwitch requested a review from Jakob37 July 15, 2024 09:58
@codecov-commenter
Copy link

codecov-commenter commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.50%. Comparing base (4c8ac1b) to head (7fa19a5).
Report is 42 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #327      +/-   ##
==========================================
+ Coverage   94.40%   94.50%   +0.09%     
==========================================
  Files          35       36       +1     
  Lines        2002     2037      +35     
==========================================
+ Hits         1890     1925      +35     
  Misses        112      112              
Flag Coverage Δ
unittests 94.50% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@Jakob37
Copy link
Collaborator

Jakob37 commented Jul 15, 2024

Nice! On holiday this week, back in office next

@northwestwitch
Copy link
Member Author

Nice! On holiday this week, back in office next

Sure, no rush, enjoy! 🌴

Copy link
Collaborator

@Jakob37 Jakob37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and clear. Nice 👌

Makes sense as you say to make sure it is included in the exported PDF.

chanjo2

@northwestwitch northwestwitch merged commit add8f6d into main Jul 22, 2024
7 checks passed
@northwestwitch northwestwitch deleted the clarify_pooled_stats branch July 22, 2024 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify "Average coverage"
3 participants