FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: make note formatting more consistent by GeorgeSapkin · Pull Request #3520 · nodejs/nodejs.org · GitHub

/ nodejs.org Public

docs: make note formatting more consistent - #3520

Merged
XhmikosR merged 4 commits into
nodejs:masterfrom
GeorgeSapkin:docs/more-consistent-notes
Feb 14, 2021
ConversationCommits (4)ChecksFiles changed
Merged

docs: make note formatting more consistent#3520
XhmikosR merged 4 commits into
nodejs:masterfrom
GeorgeSapkin:docs/more-consistent-notes

Conversation

GeorgeSapkin commented Nov 15, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

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 commented Nov 15, 2020

Copy link
Copy Markdown
Member

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

GeorgeSapkin commented Nov 15, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

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 commented Nov 16, 2020

Copy link
Copy Markdown
Member

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.

phillipj approved these changes Nov 16, 2020
View reviewed changes

phillipj left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 force-pushed the docs/more-consistent-notes branch 2 times, most recently from fad2d6b to 9f57a99 Compare November 16, 2020 12:38

GeorgeSapkin commented Nov 16, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

I removed Note: and rebased.

sonicdoe commented Nov 16, 2020

Copy link
Copy Markdown
Contributor

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

GeorgeSapkin force-pushed the docs/more-consistent-notes branch 4 times, most recently from 62eae28 to b16b9d5 Compare November 20, 2020 19:00
GeorgeSapkin force-pushed the docs/more-consistent-notes branch from b16b9d5 to e2f93b1 Compare November 23, 2020 12:53
XhmikosR merged commit 17f641b into nodejs:master Feb 14, 2021
GeorgeSapkin deleted the docs/more-consistent-notes branch February 14, 2021 05:39
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
phillipj phillipj approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Back | FazBrowse Home | New Git URL