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

Clarity of language around what alex checks for, in README #267

Closed
BNewing opened this issue Jan 3, 2020 · 2 comments
Closed

Clarity of language around what alex checks for, in README #267

BNewing opened this issue Jan 3, 2020 · 2 comments
Labels
📚 area/docs This affects documentation ⛵️ status/released This is released 🦋 type/enhancement This is great to have

Comments

@BNewing
Copy link

BNewing commented Jan 3, 2020

In the README, there is the following text:

alex checks things such as:

  • Gendered work-titles, such as suggesting garbage collector for garbageman and proprietor for landlord
  • Gendered proverbs, such as suggesting bravely for like a man, or courteous for ladylike.
  • Ablist language, such as suggesting person with learning disabilities for learning disabled
  • Condescending language, such as warning for obviously, everyone knows, etc
  • Intolerant phrasing, such as suggesting primary and replica instead of master and slave
    Profanities, such as butt 🍑

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 :)

@wooorm
Copy link
Member

wooorm commented Jan 9, 2020

How about this?

**alex** checks things such as:

*   Gendered work-titles (if you write `garbageman` alex suggests `garbage collector`; if you write `landlord` alex suggests `proprietor`)
*   Gendered proverbs (if you write `like a man` alex suggests `bravely`; if you write `ladylike` alex suggests `courteous`)
*   Ablist language (if you write `learning disabled` alex suggests `person with learning disabilities`)
*   Condescending language (if you write `obviously ` or `everyone knows` alex warns about it)
*   Intolerant phrasing (if you write `master` and `slave` alex suggests `primary ` and `replica`)
*   Profanities (if you write `butt` 🍑 alex warns about it)

…and much more!

Note: alex assumes good intent: that you don’t mean to offend!

@wooorm wooorm added 📚 area/docs This affects documentation 🙆 status/confirmed This is open and confirmed: ready to be worked on 🦋 type/enhancement This is great to have labels Jan 9, 2020
@BNewing
Copy link
Author

BNewing commented Jan 23, 2020

Looks good to me :D

@wooorm wooorm closed this as completed in 3629145 Jan 24, 2020
@wooorm wooorm added ⛵️ status/released This is released and removed 🙆 status/confirmed This is open and confirmed: ready to be worked on labels Mar 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation ⛵️ status/released This is released 🦋 type/enhancement This is great to have
Development

No branches or pull requests

2 participants