Sinon: More inclusive language in the docs

[carolstran]

:wave: Sorry I know I'm ignoring all of your well-thought out templates, but I wasn't sure where this would land! Here me out...

I noticed that there are many instances of the word "simply" in your documentation. Unfortunately, words like this can make people feel frustrated and isolated while reading (myself included, hence the issue) - especially if they are facing issues.

If it's alright with your team, I'd like to take a shot at updating the content to make it more inclusive by removing instances of "simply", "easy", "just", etc. I'm part of the team behind Unmock and we're using Sinon quite a bit, so I'm happy to help 😊

Also if you're interested or want more information on this topic, I'd highly recommend watching Jim Fisher's Don't Say Simply talk from Write the Docs Prague 2018 ✍️ 🤓

Thank you for the work you do and please let me know if you need more details!

[mroderick]

Improving the language of the documentation would be most welcome! 👏

Aside: I am working on removing use of "just" from my language, where it would be used as a synonym for "simply"

[carolstran]

Yay! I'm on it 🚀

And @mroderick, SAME 🙈 I've always been pretty careful about simply, but "just" has recently come to my attention especially because I tend to use it when explaining things out loud 😬

[mroderick]

"Can't we just ...?" 😱

[carolstran]

👋 Quick question, I was reading the CONTRIBUTING.md for the docs and I'm wondering if for a change like this it's better to change just for the existing release or for all releases... I started doing the latter but then realized it was 500+ files so thought I'd check first 😅

Thanks in advance for any insights!

[mroderick]

We are considering how to restructure the documentation, so this challenge won’t keep getting bigger with every release.

I’d say, go ahead and change it only for the next release.

[fatso83]

I have a branch lying somewhere where I trimmed the docs to a single release for each major (basically the latest version for each major). I guess I should finish that ... :)

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[carolstran]

Thanks stale bot! This totally fell off my plate, but I have some time this week where I can work on it 😊