docs: more detail for command line flags #8708
Open
Conversation
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
wraithgar
reviewed
Nov 3, 2025
|
|
||
| ### See also | ||
|
|
||
| * [npm config](/commands/npm-config) |
Member
There was a problem hiding this comment.
All of the other files in docs use * so let's keep it consistent here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 documentation for command-line flags uses “foo” and “bar” as placeholders without clarifying that they are generic examples of a key and a value.
New readers unfamiliar with this convention may interpret them as literal parameters. Suggest adding a short note as given explaining that “foo/bar” are placeholders for any config key/value.
This branch includes a full rewrite.
This change was originally suggested in npm/documentation#1760 — applying it here since the CLI docs are the true source