Uh oh!
There was an error while loading. Please reload this page.
docs: make note formatting more consistent - #3520
Conversation
Trott
commented
Nov 15, 2020
Looks fine to me, although I wonder if the thing to do is remove |
What are you suggesting? Just leave the note text without the word
I don't have a strong opinion. I'm updating the event loop guide and this irks me somewhat. |
Trott
commented
Nov 16, 2020
Yes, that's what I'm suggesting, but like you, I don't have a particularly strong opinion. The change here is 👍 by me, as would getting rid of |
There was a problem hiding this comment.
LGTM either way, with or without Note:.
If I'd have to choose, I'd lean slightly towards getting rid of Note:, primarily because the text that follows it has now been updated to be markdown quotes, which I'm assuming will highlight it a bit compared to other non-quote parts of these guides.
fad2d6b to
9f57a99CompareI removed |
sonicdoe
commented
Nov 16, 2020
To support removing “Note:” completely, we’ve made the same change two years ago in nodejs/node#18592. |
62eae28 to
b16b9d5Compareb16b9d5 to
e2f93b1Compare
The note formatting seems to differ among various parts of the docs, so I've tried to normalize it a bit. I've only touched the English bits for now. I've picked the style that seems to be the most popular: