doc: clarify explanation of first stream section #4234
Conversation
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it.
mscdex
added
doc
|
cc @Trott |
|
I think the sentence can just be removed. It doesn't add any value, IMO. |
|
+1 to simply removing that sentence. |
|
+1 to removal, that section could even be turned into a numbered list for more clarity. Having "This document is split up into 3 sections." alone on a line might make it more likely that people will read it (I bet it hardly ever gets read). Thanks for the PR @vekat, it looks like this will be your first contribution to Node core, welcome! |
|
Hi everybody, thanks for the feedback. @rvagg so what would be the best way to proceed here? I'm thinking I could locally revert my initial commit (possibly with rebase -i) and implement your suggestions, then force push a new commit to rewrite my branch. |
|
@vekat You can just make the changes right on top of the commit you already made. Then either you can squash and force push, or just push normally and there will be two commits in this PR. Whoever lands the PR will squash the two commits to one commit, so it's not a big deal if you don't do it. |
The last sentence explaining the first stream section was removed as it didn't add much value to the explanation. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability.
|
Thanks for the quick answer @Trott. |
|
LGTM |
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. PR-URL: #4234 Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 3470574 |
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. PR-URL: #4234 Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in v4.x-staging in 5608267 |
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. PR-URL: #4234 Reviewed-By: James M Snell <jasnell@gmail.com>
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. PR-URL: #4234 Reviewed-By: James M Snell <jasnell@gmail.com>
The last sentence of the explanation for the first stream section seemed a bit confusing. I tried to change the sentence to clarify it. Additionally, the sections were turned into a numbered list to be more clear about which section is being described, and improve readability. PR-URL: nodejs#4234 Reviewed-By: James M Snell <jasnell@gmail.com>
The last sentence of the explanation for the first stream section
seemed a bit confusing. I tried to change the sentence to clarify it.