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.

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

[DOCS] Missing backtick in synopsis of npm-init #5837

Closed
2 tasks done
robin-a-meade opened this issue Nov 9, 2022 · 4 comments
Closed
2 tasks done

[DOCS] Missing backtick in synopsis of npm-init #5837

robin-a-meade opened this issue Nov 9, 2022 · 4 comments
Labels
Documentation documentation related issue

Comments

@robin-a-meade
Copy link

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 synopsis of npm-init is missing a backtick.

npm init <package-spec> (same as `npx <package-spec>)

should be:

npm init <package-spec> (same as `npx <package-spec>`)

Affected versions 8x and 9x:
https://docs.npmjs.com/cli/v8/commands/npm-init
https://docs.npmjs.com/cli/v9/commands/npm-init

Potential Solution

Add the missing backtick.

Affected URL

https://docs.npmjs.com/cli/v9/commands/npm-init

@robin-a-meade robin-a-meade added Documentation documentation related issue Needs Triage needs review for next steps labels Nov 9, 2022
@Peallyz
Copy link
Contributor

Peallyz commented Dec 20, 2022

I guess this issue can't be done on this repo.
I created a PR at npm/documentation, awaiting approval.
If i did well this issue will be able to be closed.

@lukekarrys
Copy link
Contributor

@Peallyz the fix for this issue would be made here:

'<package-spec> (same as `npx <package-spec>)',
. then the docs site will be updated with the generated changes

@Peallyz
Copy link
Contributor

Peallyz commented Jan 12, 2023

Okay, i'm on it to handle this issues with the right way.
Sorry for the wasted time.

@lukekarrys
Copy link
Contributor

Thank you for the fix @Peallyz!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation documentation related issue
Projects
None yet
Development

No branches or pull requests

3 participants