Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] completion synopsis is wrong/not-useful (v8) #4620

Open
2 tasks done
chalin opened this issue Mar 25, 2022 · 1 comment · May be fixed by #7996
Open
2 tasks done

[DOCS] completion synopsis is wrong/not-useful (v8) #4620

chalin opened this issue Mar 25, 2022 · 1 comment · May be fixed by #7996
Labels
Documentation documentation related issue Priority 2 secondary priority issue

Comments

@chalin
Copy link

chalin commented Mar 25, 2022

Is there an existing issue for this?

  • I have searched the existing issues

This is a CLI Docs Problem, not another kind of Docs Problem.

  • This is a CLI Docs Problem.

Description of Problem

The v8 completion synopsis was changed (via #4450) to the following (using a generic command template):

npm completion

This is autogenerated using a generic command template, but it is incorrect (at, at the very least, not useful). The v7 page has the right usage, namely:

source <(npm completion)

Potential Solution

Update describeUsage in https://github.com/npm/cli/blob/latest/scripts/config-doc-command.js to treat completion as a special case.

Affected URL

https://docs.npmjs.com/cli/v8/commands/npm-completion
@chalin chalin added Documentation documentation related issue Needs Triage needs review for next steps labels Mar 25, 2022
@wraithgar
Copy link
Member

wraithgar commented Mar 28, 2022 •
edited
Loading

It may be more correct to add that to the Description section, and edit it to say "Generates completion script"

@fritzy fritzy added Priority 2 secondary priority issue and removed Needs Triage needs review for next steps labels Mar 29, 2022
vassudanagunta added a commit to vassudanagunta/npm-cli that referenced this issue Dec 22, 2024
@vassudanagunta
docs: correct incorrect desc and usage in npm-completion.md
5ed2682 
Fixes npm#4620
This was referenced Dec 22, 2024
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation documentation related issue Priority 2 secondary priority issue
Projects
None yet
Milestone
No milestone
3 participants
@wraithgar @fritzy @chalin