Remove “words to avoid in technical writing” #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Words were taken from this blog post: http://css-tricks.com/words-avoid-educational-writing/. It recommends to avoid using the phrases “obviously”, “basically”, “simply”, “of course”, “clearly”, “just”, “everyone knows”, “however”, “so” and “easy”. I did a project-wide search for these phrases and rewrote things where I thought it improved the sentence. For future reference, this is the command I ran to find these: ag -i '(obviously|basically|simply|of\scourse|clearly|just|everyone\sknows|however|so,|easy)' user
|
LOVE THIS! |
|
Words matter a lot, and this is a great improvement! |
joshk
added a commit
that referenced
this pull request
Feb 3, 2014
Remove “words to avoid in technical writing”
|
@henrikhodne such a wonderful step <3 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Words were taken from this blog post: http://css-tricks.com/words-avoid-educational-writing/. It recommends to avoid using the phrases “obviously”, “basically”, “simply”, “of course”, “clearly”, “just”, “everyone knows”, “however”, “so” and “easy”. I did a project-wide search for these phrases and rewrote things where I thought it improved the sentence.
For future reference, this is the command I ran to find these:
Not 100% sure about all of these changes, please do look over them and add some comments if you think there shouldn't be a change or the sentence could be rewritten in a better way.