Skip to content

Conversation

@ethomson
Copy link
Contributor

@ethomson ethomson commented Feb 9, 2021

The docs.npmjs.com parser is extremely strict about angle brackets; use
< and >.

The docs.npmjs.com parser is extremely strict about angle brackets; use
`<` and `>`.
@ethomson ethomson requested a review from a team as a code owner February 9, 2021 19:17
@wraithgar
Copy link
Member

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 Array<String>

@wraithgar
Copy link
Member

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

Copy link
Member

@wraithgar wraithgar left a 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!

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

Labels

release: next These items should be addressed in the next release Release 7.x work is associated with a specific npm 7 release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants