Clarify placeholder usage (‘foo’/‘bar’) in CLI flag documentation
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 712
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with content/cli/v11/using-npm/config.mdx and locate the command-line flag examples using “foo” and “bar.” Add a brief explanation that they represent generic configuration keys and values, then review the surrounding documentation to confirm the note is clear and the examples are not presented as literal parameters.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100