Improve numerical readability scores for the tutorial.#546
Merged
Saransh-cpp merged 9 commits intomainfrom Jul 14, 2025
Merged
Conversation
…adability-scores-tutorial
for more information, see https://pre-commit.ci
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the tutorial to improve readability by simplifying language and rephrasing steps, and it enables the Vale Readability checks.
- Simplified and restructured tutorial sentences for clarity and brevity
- Added Vale Readability style to
.vale.ini - Cleaned up formatting and links in the tutorial
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tutorial.md | Reworded steps and tips, improved flow, and added concise phrasing |
| .vale.ini | Added Readability package to enforce readability metrics in Vale scans |
Comments suppressed due to low confidence (1)
tutorial.md:286
- [nitpick] Clarify this instruction by specifying the actual prompt indicator, for example: 'you should see
(.venv)or(your_env_name)on the left of your terminal prompt'.
So activate your environment and you should see braces `( )` with your project slug on the left of your terminal window.
samcunliffe
commented
Jul 14, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Member
Author
|
(tagging @matt-graham and @paddyroddy: feel free but under no obligation to join the review) |
Saransh-cpp
approved these changes
Jul 14, 2025
Contributor
Saransh-cpp
left a comment
There was a problem hiding this comment.
Thanks, @samcunliffe!! I went through the whole thing (while practising for tomorrow) and it looks great. I'll merge this in right now for tomorrow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Inspired by @paddyroddy 's Vale talk, improving accessibility in general, and the fun of conforming fuzzy things like language into cold, hard numbers, I've made a pass at improving some numerical readability scores for the tutorial document.
In practice, this is me going through and splitting up long sentences, reducing the use of large words, and trying to say things clearly and briefly.
Anyone can play around with this themselves using:
on this branch (with the
Readibilitypackage enabled).On the current
HEADofmain:On the
HEADof this branch:All numbers are better, though most are still "warning" level (we only lost the ARI).
Now! I'm aware this is coming very close to the tutorial delivery (sorry!!). So we might want to wait on merging this until afterwards. I leave it up to you @Saransh-cpp. You're the workshop lead...