Clarify placeholder usage (‘foo’/‘bar’) in CLI flag documentation #1760
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
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 explaining that “foo/bar” are placeholders for any config key/value.
A more comprehensive rewrite of this section that builds on the prior clarification.
|
The copy looks good, will need |
SuperHeavyBallet
had a problem deploying
to
github-pages
GitHub Actions
Failure
|
|
|
Oooh sorry I missed that this was in the cli content folder. That content is not sourced from this repo it's pulled in from npm itself so that we can keep its config and help output tightly coupled to the web content. This content is actually sourced from https://github.com/npm/cli/blob/latest/docs/lib/content/using-npm/config.md |
|
We typically do not backport docs changes like this so the older npm versions will stay as-is. |
|
Closing this PR. The change has been migrated to npm/cli#8708, which is the correct source for this content. |
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.
Update:
This branch includes both a minor clarification and a full rewrite. I’m happy to separate them into two PRs if preferred.