docs: update npm-diff to exclude angle brackets#2662
Closed
ethomson wants to merge 3 commits intonpm:latestfrom
Closed
docs: update npm-diff to exclude angle brackets#2662ethomson wants to merge 3 commits intonpm:latestfrom
ethomson wants to merge 3 commits intonpm:latestfrom
Conversation
The docs.npmjs.com parser is extremely strict about angle brackets; use `<` and `>`.
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 |
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 |
wraithgar
reviewed
Feb 9, 2021
wraithgar
reviewed
Feb 9, 2021
Co-authored-by: Gar <wraithgar@github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs.npmjs.com parser is extremely strict about angle brackets; use
<and>.