-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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: consolidate docs and help for package spec #5048
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wraithgar
force-pushed
the
gar/docs-publish-spec
branch
from
June 21, 2022 18:16
e685dd9
to
fe4e19f
Compare
wraithgar
commented
Jun 21, 2022
wraithgar
commented
Jun 21, 2022
no statistically significant performance changes detected timing results
|
wraithgar
force-pushed
the
gar/docs-publish-spec
branch
from
June 21, 2022 18:47
fe4e19f
to
9c67f79
Compare
Many of our commands parse their args via [npm-package-arg](https://npm.im/npm-package-arg), which is a good standard way of parsing a "package" argument. However the docs surrounding these args are not very consistent. This can lead to confusion in commands such as `npm publish` where the behavior is slightly different than in the past due to this. This adds a new help command `npm help package-spec` that describes what this argument is, and can be, and also updates all the commands that interpret their args this with to refer to them as `<package-spec>`. It also adds a link to the new help page on their docs pages.
wraithgar
force-pushed
the
gar/docs-publish-spec
branch
from
June 21, 2022 18:55
9c67f79
to
0167c37
Compare
Closes #4126 |
fritzy
previously requested changes
Jun 21, 2022
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.
fritzy
approved these changes
Jun 22, 2022
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Many of our commands parse their args via
npm-package-arg, which is a good
standard way of parsing a "package" argument. However the docs
surrounding these args are not very consistent. This can lead to
confusion in commands such as
npm publish
where the behavior isslightly different than in the past due to this.
This adds a new help command
npm help package-spec
that describes whatthis argument is, and can be, and also updates all the commands that
interpret their args this with to refer to them as
<package-spec>
. Italso adds a link to the new help page on their docs pages.