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

Rework the metrics used by the FileTree #161

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Pennycook
Copy link
Contributor

Related issues

Proposed changes

  • Replace the concept of "code utilization" with "coverage" and "average coverage".
  • Simplify the FileTree output by focusing in "coverage" metrics and removing redundant information.
  • Add a description of "coverage" to the documentation, alongside "code divergence".

The new report output is much more readable than the old one:

image


I've opened this as a draft to ensure that we don't accidentally merge it before #158, but I think the functionality is ready for review.

Signed-off-by: John Pennycook <[email protected]>
Presenting the amount of code used by all platforms as "coverage" is more
aligned with how we describe CBI's functionality elsewhere.

Signed-off-by: John Pennycook <[email protected]>
Small refactoring to enable later re-use.

Signed-off-by: John Pennycook <[email protected]>
This has several advantages:
- It wastes less whitespace than printing two SLOC counts.
- The reader doesn't have to perform division to calculate coverage.
- We can easily color-code coverage to highlight good/bad values.

Signed-off-by: John Pennycook <[email protected]>
@Pennycook Pennycook added documentation Improvements or additions to documentation ux Issues and PRs pertaining to user experience labels Jan 28, 2025
@Pennycook Pennycook added this to the 2.0.0 milestone Jan 28, 2025
@Pennycook Pennycook requested a review from laserkelvin January 28, 2025 12:07
Computing coverage relative to a set of platforms enables the function to be
used in more contexts.

Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
- Mention "platform coverage" in README and home page.
- Add a description of "platform coverage" to the specialization page.

Signed-off-by: John Pennycook <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ux Issues and PRs pertaining to user experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve code utilization functionality
1 participant