Improve numerical readability scores of our README - #590
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves the numerical readability scores of the README by simplifying language and restructuring content. The changes aim to make the documentation more accessible while maintaining all essential information.
Key changes:
- Simplified language and shortened sentences throughout the README
- Restructured sections with clearer headings and better organization
- Added a dedicated "Need help?" section for support information
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
I highly doubt it. We could do it in our own way fairly easily, but |
Overruled by Vale and @paddyroddy. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Patrick J. Roddy <patrickjamesroddy@gmail.com>
|
Cheers, Paddy! I've re-requested a review from @UCL-ARC/collaborations-python-tooling to get a second. @matt-graham and @dstansby, you both wrote earlier versions of this, so your opinions are gratefully received. (If you have the capacity to review...) |
|
I will update this. It's been ages but still feels worthwhile. |
matt-graham
left a comment
There was a problem hiding this comment.
This all looks great to me, thanks @samcunliffe for picking this up again.
Following on from #546, I've reworded our README, using vale's Readability suite.
I don't think there's a nice way to get vale to make a comparison of values between two commits (@paddyroddy?), so here's a manual comparison table (which I hope is helpful, because it was very boring to make!)
You can check these yourself with:
cd /place/where/this/repo/is vale sync vale README.md