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

docs: update with cross tool search and issues / kloc #2252

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

alerizzo
Copy link
Contributor

No description provided.

@alerizzo alerizzo requested a review from a team October 31, 2024 12:30
@alerizzo alerizzo requested a review from a team as a code owner October 31, 2024 12:30
Copy link
Contributor

Overall readability score: 53.71 (🟢 +0.02)

File Readability
which-metrics-does-codacy-calculate.md 60.1 (🟢 +0.18)
using-coding-standards.md 62.14 (🟢 +0.31)
configuring-code-patterns.md 60.33 (🟢 +2.7)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
which-metrics-does-codacy-calculate.md 60.1 38.62 9.49 11.9 13.11 6.51
  🟢 +0.18 🟢 +0.3 🟢 +0.14 🟢 +0.1 🔴 -0.18 🟢 +0
using-coding-standards.md 62.14 39.84 8.6 11.8 13.33 6.36
  🟢 +0.31 🟢 +0 🟢 +0.03 🟢 +0.1 🟢 +0.06 🟢 +0.01
configuring-code-patterns.md 60.33 38.82 9.49 11.3 12.24 7.1
  🟢 +2.7 🟢 +0.2 🟢 +0.52 🟢 +0.3 🟢 +0.29 🟢 +0.29

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.71 42.84 10.84 12.53 12.59 7.94
  🟢 +0.02 🟢 +0 🟢 +0 🟢 +0 🟢 +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

@github-actions github-actions bot temporarily deployed to Netlify October 31, 2024 12:31 Inactive
@alerizzo alerizzo enabled auto-merge (squash) October 31, 2024 12:32
@alerizzo alerizzo merged commit de01112 into master Nov 4, 2024
6 checks passed
@alerizzo alerizzo deleted the clean-doc-general-updates branch November 4, 2024 13:25
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.

2 participants