8000 Improve numerical readability scores for the tutorial. by samcunliffe · Pull Request #546 · UCL-ARC/python-tooling · GitHub
[go: up one dir, main page]
Skip to content

Improve numerical readability scores for the tutorial. #546

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Improve numerical readability scores for the tutorial. #546

wants to merge 3 commits into from

Conversation

samcunliffe
Copy link
Member
@samcunliffe samcunliffe commented Jun 9, 2025 •
edited
Loading 
❯ vale tutorial.md

 tutorial.md
 1:1      warning  Try to keep the LIX score       Readability.LIX
                   (47.71) below 35.
 1:1      warning  Try to keep the Automated       Readability.AutomatedReadability
                   Readability Index (11.64)
                   below 8.
 1:1      warning  Try to keep the Coleman–Liau    Readability.ColemanLiau
                   Index grade (11.12) below 9.
 1:1      warning  Try to keep the Flesch–Kincaid  Readability.FleschKincaid
                   grade level (11.87) below 8.
 1:1      warning  Try to keep the Gunning-Fog     Readability.GunningFog
                   index (13.52) below 10.
 1:1      warning  Try to keep the SMOG grade      Readability.SMOG
                   (13.25) below 10.
 1:1      warning  Try to keep the Flesch reading  Readability.FleschReadingEase
                   ease score (46.86) above 70.
 10:34    error    Consider using the '…' symbol   proselint.Typography
                   instead of '...'.
 201:1    error    Don't start a sentence with     write-good.ThereIs
                   'There are'.
 201:269  warning  'extremely' is a weasel word!   write-good.Weasel

@samcunliffe samcunliffe changed the title ... Improve numerical readability scores for the tutorial. Jun 9, 2025
@samcunliffe samcunliffe marked this pull request as draft June 9, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@samcunliffe
0