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

feat: Coverage ignore caveats tweaks ALA-695 #1987

Conversation

nicklem
Copy link
Contributor

@nicklem nicklem commented Dec 18, 2023

❗ WIP

Post-release tweaks to improve the clarity and usability of documentation pages when mentioning the caveat that Coverage does not ignore any files.

👀 Live preview

  • WIP

@github-actions github-actions bot temporarily deployed to Netlify December 18, 2023 16:27 Inactive
Copy link
Contributor

github-actions bot commented Dec 18, 2023

Overall readability score: 54.27 (🟢 +0.04)

File Readability
coverage-ignore.md 13.83 (🟢 +0.04)
cloud-2023-11-23-new-coverage-engine-status-checks.md 57.28 (🟢 +0)
ignoring-files.md 65.02 (🟢 +7.62)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
coverage-ignore.md 13.83 26.48 19 21.6 13.41 10.69
  🟢 +0.04 🟢 +1.02 🟢 +0 🟢 +0.3 🔴 -0.17 🔴 -0.1
cloud-2023-11-23-new-coverage-engine-status-checks.md 57.28 48.84 11.37 13.5 11.55 6.87
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
ignoring-files.md 65.02 54.42 10.3 10.2 10.44 7.3
  🟢 +7.62 🟢 +4.56 🟢 +1.66 🟢 +2.2 🟢 +0.06 🟢 +0.23

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.27 43.12 10.85 12.36 12.53 7.87
  🟢 +0.04 🟢 +0.03 🟢 +0.01 🟢 +0.01 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@nicklem nicklem self-assigned this Dec 19, 2023
…cks-release-note-with-migration-instructions
@github-actions github-actions bot temporarily deployed to Netlify December 22, 2023 10:14 Inactive
…cks-release-note-with-migration-instructions
@github-actions github-actions bot temporarily deployed to Netlify January 2, 2024 16:11 Inactive
@nicklem
Copy link
Contributor Author

nicklem commented Jan 11, 2024

Closing this one, as these edits won't provide much value for now.

@nicklem nicklem closed this Jan 11, 2024
@github-actions github-actions bot temporarily deployed to Netlify January 11, 2024 16:02 Inactive
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.

1 participant