documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Clarify placeholder usage (‘foo’/‘bar’) in CLI flag documentation

Open SuperHeavyBallet opened this issue 2 months ago • 0 comments

Summary: 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. Why it matters: 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.

Location Example: https://github.com/npm/documentation/blob/main/content/cli/v11/using-npm/config.mdx

SuperHeavyBallet avatar Oct 29 '25 10:10 SuperHeavyBallet