doc: avoid colloquialism #12417
doc: avoid colloquialism #12417
Conversation
mscdex
added
the
meta
COLLABORATOR_GUIDE.md
Outdated
| @@ -345,7 +345,7 @@ Additionally: | |||
|
|
|||
| ### Technical HOWTO | |||
|
|
|||
| _Optional:_ ensure that you are not in a borked `am`/`rebase` state | |||
| Optional: Clear any `am`/`rebase` that is already underway. | |||
There was a problem hiding this comment.
This isn't really optional, it's necessary if you are in an am or rebase state. People who are less familiar with Git aren't going to know whether or not they need to do it.
Maybe say something like:
If
git statusshowsRebase in progressorYou are in the middle of an am session., then you need to cancel therebaseoramwith:
There was a problem hiding this comment.
Removed the optional label.
@gibfahn LGTY now?
|
I'm +0. Googled Also, agree with @gibfahn regarding the optional part. |
|
I'm But I'm suggesting a more extensive Edit (PR to come): |
| @@ -345,7 +345,7 @@ Additionally: | |||
|
|
|||
There was a problem hiding this comment.
Up there (out of context) 309 & 311 are almost dups. also I'd pull "Please never use GitHub's green" down here.
There was a problem hiding this comment.
But I digress, I'll do this myself.
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc.
@benjamingr FWIW (and it probably depends on what Google knows about you), when I Google "borked", the first thing I see is this definition:
I think that's probably more confusing in this context than helpful. |
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Landed in 296f331 |
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: #12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word "borked" in our documentation today. Reword to avoid colloquialisms. It's more precise and clear this way anyway. Also reformat `Optional:` to be consistent with how it appears elsewhere in the doc. PR-URL: nodejs/node#12417 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
I witnessed an English-as-a-second-language speaker puzzle over the word
"borked" in our documentation today. Reword to avoid colloquialisms.
It's more precise and clear this way anyway. Also reformat
Optional:to be consistent with how it appears elsewhere in the doc.
Checklist
Affected core subsystem(s)
doc