Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Update README.md by adding missing formattings#2617

Open
0xdw wants to merge 1 commit intonodejs:mainfrom
0xdw:patch-1
Open

Update README.md by adding missing formattings#2617
0xdw wants to merge 1 commit intonodejs:mainfrom
0xdw:patch-1

Conversation

Copy link

0xdw commented Feb 18, 2022 *
edited
Loading

Description of change

Added missing formattings to keep the README.md more clear

0xdw changed the title Update README.md by adding missing formatings Update README.md by adding missing formattings Feb 18, 2022
Copy link
Member

rvagg commented Feb 21, 2022

So .. while this does increase the consistency, I personally dislike that we have node-gyp throughout the readme where it's just referring to the name rather than showing CLI or programmatic usage. I think we've gone back and forth on this question but my vote is to rip them all out.

Not a hard blocker if someone else feels strongly about this.

Thanks for the thoughtful contribution though @0xdw.

cclauss and 0xdw reacted with thumbs up emoji

Copy link
Author

0xdw commented Feb 21, 2022

@rvagg Agreed! What I thought is that it's better to have a single way of stating the name. Also, I prefer to have the module name highlighted :).

Copy link
Contributor

cclauss commented May 10, 2022

Repetitive highlighting is distracting for the reader.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants