-
Notifications
You must be signed in to change notification settings - Fork 6.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: make note formatting more consistent #3520
docs: make note formatting more consistent #3520
Conversation
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. |
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
9f57a99
Compare
I removed |
To support removing “Note:” completely, we’ve made the same change two years ago in nodejs/node#18592. |
62eae28
to
b16b9d5
Compare
b16b9d5
to
e2f93b1
Compare
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: