Skip to content

fix some docs#2364

Merged
DMarinhoCodacy merged 3 commits intomasterfrom
fix-some-docs
Mar 12, 2025
Merged

fix some docs#2364
DMarinhoCodacy merged 3 commits intomasterfrom
fix-some-docs

Conversation

@DMarinhoCodacy
Copy link
Contributor

👀 Live preview

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

@DMarinhoCodacy DMarinhoCodacy requested a review from a team as a code owner March 12, 2025 15:12
@github-actions
Copy link
Contributor

github-actions bot commented Mar 12, 2025

Overall readability score: 53.25 (🟢 +0)

File Readability
configuring-code-patterns.md 60.18 (🟢 +0)
codacy-configuration-file.md 56.43 (🟢 +0)
managing-security-and-risk.md 52.08 (🟢 +0)
supported-languages-and-tools.md 47.6 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
configuring-code-patterns.md 60.18 38.82 9.49 11.3 12.35 7.1
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
codacy-configuration-file.md 56.43 36.49 10.13 13.2 13.05 6.64
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
managing-security-and-risk.md 52.08 34.76 10.69 14.4 13.92 6.68
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
supported-languages-and-tools.md 47.6 31.17 10.59 13.8 15.07 7.71
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.25 42.76 10.87 12.64 12.7 7.96
  🟢 +0 🟢 +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 March 12, 2025 15:13 Inactive
@github-actions github-actions bot temporarily deployed to Netlify March 12, 2025 15:33 Inactive
@github-actions github-actions bot temporarily deployed to Netlify March 12, 2025 15:37 Inactive
@DMarinhoCodacy DMarinhoCodacy merged commit bfdde77 into master Mar 12, 2025
6 checks passed
@DMarinhoCodacy DMarinhoCodacy deleted the fix-some-docs branch March 12, 2025 15:42
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