Skip to content
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

Merged
merged 4 commits into from
Feb 14, 2021

Conversation

GeorgeSapkin
Copy link
Contributor

@GeorgeSapkin GeorgeSapkin commented Nov 15, 2020

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:

Note: Details here.

@Trott
Copy link
Member

Trott commented Nov 15, 2020

Looks fine to me, although I wonder if the thing to do is remove Note: entirely.

@GeorgeSapkin
Copy link
Contributor Author

GeorgeSapkin commented Nov 15, 2020

What are you suggesting? Just leave the note text without the word Note:?

Note: Details here.

I don't have a strong opinion. I'm updating the event loop guide and this irks me somewhat.

@Trott
Copy link
Member

Trott commented Nov 16, 2020

What are you suggesting? Just leave the note text without the word Note:?

Note: Details here.

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 Note: entirely. Maybe let's see what @nodejs/website folks thing.

Copy link
Member

@phillipj phillipj left a 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.

@GeorgeSapkin GeorgeSapkin force-pushed the docs/more-consistent-notes branch 2 times, most recently from fad2d6b to 9f57a99 Compare November 16, 2020 12:38
@GeorgeSapkin
Copy link
Contributor Author

GeorgeSapkin commented Nov 16, 2020

I removed Note: and rebased.

@sonicdoe
Copy link
Contributor

To support removing “Note:” completely, we’ve made the same change two years ago in nodejs/node#18592.

@GeorgeSapkin GeorgeSapkin force-pushed the docs/more-consistent-notes branch 4 times, most recently from 62eae28 to b16b9d5 Compare November 20, 2020 19:00
@XhmikosR XhmikosR merged commit 17f641b into nodejs:master Feb 14, 2021
@GeorgeSapkin GeorgeSapkin deleted the docs/more-consistent-notes branch February 14, 2021 05:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants