Clarity of language around what alex checks for, in README #267
Labels
📚 area/docs
This affects documentation
⛵️ status/released
This is released
🦋 type/enhancement
This is great to have
In the README, there is the following text:
I don't know if it's just me, but it took me a couple of read throughs to understand fully what it meant. 'alex checks things such as gendered work-titles' makes sense on it's own. But suggesting something is slightly separate to checking, and it took me a few read-throughs to get what it was saying. It was only when I went to look at the table view that's linked that it clicked which of the two suggested things were the suggestions from alex, and what it was replacing.
I'm not sure what it could be changed to - I'm not the best with words, and I'm sure this explanation could be clearer too! One thing that could be done is listing what it suggests as a separate list/table on the README. Just one thought :)
The text was updated successfully, but these errors were encountered: