-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Correct command line usage messages #214
Conversation
@@ -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>] |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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>]
@Low-power appreciate the contribution but we're trying to limit the churn on the |
<>
should not be used for words that intent to use 'as is'.Also fixed the on-line usage string of subcommand
npm ping
.