-
Notifications
You must be signed in to change notification settings - Fork 3.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: update npm-diff to exclude angle brackets #2662
Conversation
The docs.npmjs.com parser is extremely strict about angle brackets; use `<` and `>`.
The fact that we don't have any other errors in the rest of our markdown files makes me think we may have a consistency issue with how we type things up. I checked some other markdowns and we don't use angle brackets like this when referring to parameters in the explanations, and nowhere else do we define arrays like that |
Ah, found a good example. In the other places we use angle brackets in the explanations, we have backticked things to make them stand out. cf https://docs.npmjs.com/cli/v6/commands/npm-pack#description |
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.
Thanks @ethomson for keeping on top of this!
The docs.npmjs.com parser is extremely strict about angle brackets; use
<
and>
.