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

Correct command line usage messages #214

Closed
wants to merge 1 commit into from

Conversation

Low-power
Copy link

<> should not be used for words that intent to use 'as is'.

Also fixed the on-line usage string of subcommand npm ping.

@Low-power Low-power requested a review from a team as a code owner July 16, 2019 04:02
@@ -6,7 +6,7 @@ npm-access(1) -- Set access level on published packages
npm access public [<package>]
npm access restricted [<package>]

npm access grant <read-only|read-write> <scope:team> [<package>]
npm access grant read-only|read-write <scope:team> [<package>]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not? without the angle brackets it might be confused for being pipes.

Copy link
Author

@Low-power Low-power Jul 16, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, | should never mean pipe in SYNOPSIS section of manuals or on-line usage message.

Could I understand the < character as the read-open-redirect operator in UNIX shell?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

However this change could make the 'or' items be misleading, so please also consider followings:

npm access grant {read-only|read-write} <scope:team> [<package>]
or
npm access grant (read-only|read-write) <scope:team> [<package>]

@darcyclarke darcyclarke added the Priority Backlog a "backlogged" item that will be tracked in a Project Board label Nov 19, 2019
@darcyclarke darcyclarke added Release 6.x work is associated with a specific npm 6 release semver:patch semver patch level for changes and removed Priority Backlog a "backlogged" item that will be tracked in a Project Board labels Mar 18, 2020
@darcyclarke
Copy link
Contributor

@Low-power appreciate the contribution but we're trying to limit the churn on the 6.x release line at the moment so I'm closing this for now. Feel free to reopen or make changes against the new documentation once we've shipped 7.x.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release 6.x work is associated with a specific npm 6 release semver:patch semver patch level for changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants