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-2506: Add raises to write_markdown #3043

Merged
merged 2 commits into from
Jun 20, 2024
Merged

Conversation

npentrel
Copy link
Collaborator

@andf-viam I accidentally did this while investigating #3042. Didn't see it was assigned to you. Feel free to wait with merging this until after presentation.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jun 19, 2024
@viambot
Copy link
Member

viambot commented Jun 19, 2024

Overall readability score: 53.07 (🟢 +0)

File Readability
app.md 61.99 (🟢 +2.54)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
app.md 61.99 32.8 6.29 15.6 14.31 5.13
  🟢 +2.54 🔴 -0.2 🟢 +0.07 🟢 +0.8 🟢 +0.64 🟢 +0.12

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.07 45.74 11.13 12.58 12.11 8.32
  🟢 +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

Copy link
Contributor

@andf-viam andf-viam left a comment

Choose a reason for hiding this comment

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

This LGTM with one additional fix from me. Turns out I wasn't properly resetting the previous error's content before gathering the next, when dealing with the (rare) cases of multiple errors. Thanks for tackling this ticket!!

@viambot
Copy link
Member

viambot commented Jun 20, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3043

@npentrel npentrel merged commit b508799 into viamrobotics:main Jun 20, 2024
10 checks passed
@npentrel npentrel deleted the DOS-2506 branch June 20, 2024 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants