search

backdrop / backdrop-issues

Issue tracker for Backdrop core.
144 stars 39 forks source link

Remove belittling words from all docs in the Backdrop codebase #3351

Open jenlampton opened 5 years ago

jenlampton commented 5 years ago

Describe your issue or idea

In an attempt to make the code more welcoming to newcomers and coding beginners, we should remove phrases like "just", "of course", "simply", "easily", "obviously" from our in-code documentation.

Based on the fantastic idea from Symfony: https://twitter.com/symfonydocs/status/1056912807034265600

herbdool commented 5 years ago

There are a few other small changes in this PR not mentioned, such as removing space before the top docblock. But it all looks fine.

jenlampton commented 5 years ago

...such as removing space before the top docblock

Yeah, I try to make that change along with all the others I'm doing. It's not the kind of improvement that's worth an issue of it's own, but if I'm in a file anyway I try to take care of it :) You'll see that a lot from me!

quicksketch commented 5 years ago

Thanks, I merged all the changes in the available PRs. As this is already 3 major instances, I'm going to close this issue. Please open a new issue for any further replacements.

quicksketch commented 5 years ago

These were merged both into 1.x and 1.11.x btw, so this will be in 1.11.3.

jenlampton commented 5 years ago

There's a few more words we should remove from the codebase (just, and some others) so I'd like to leave this open for a bit.

jenlampton commented 5 years ago

no final PR here, removing milestone.