Skip to content

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

Open
@chalin

Description

@chalin

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

Activity

wraithgar

wraithgar commented on Mar 28, 2022

@wraithgar
Member

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

added
Priority 2secondary priority issue
and removed
Needs Triageneeds review for next steps
on Mar 29, 2022
added a commit that references this issue on Dec 22, 2024
5ed2682
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentationdocumentation related issuePriority 2secondary priority issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @wraithgar@fritzy@chalin

      Issue actions

        [DOCS] `completion` synopsis is wrong/not-useful (v8) · Issue #4620 · npm/cli