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: update publish docs: dist-tag + publish case #7560

Merged
merged 1 commit into from
May 28, 2024
Merged

docs: update publish docs: dist-tag + publish case #7560

merged 1 commit into from
May 28, 2024

Conversation

davidlj95
Copy link
Contributor

Updates publish command docs:

  • Refers to npm tag which is now npm dist-tag
  • Add docs specific for npm publish --tag

References

@davidlj95 davidlj95 requested a review from a team as a code owner May 27, 2024 00:51
Also the tag that is added to the package@version specified by the \`npm
tag\` command, if no explicit tag is given.
Also the tag that is added to the package@version specified by the
\`npm dist-tag add\` command, if no explicit tag is given.
Copy link
Contributor

Choose a reason for hiding this comment

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

The grammar of this sentence was not and still is not correct.

"The tag is also added to ... "

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I read it several times and thought something was wrong but wasn't 100% sure as not a native English speaker.

The tag is also added for me sounds like same tag is added in two places, whilst they're describing two different scenarios (what happens for the config / CLI arg in npm i vs npm dist-tag add.

Updated it to be:

It is the tag added to the package@version specified in the npm dist-tag add command, if no explicit tag is given.

Changed also the by -> in as the users specifies the package@version to the command (it's not the command the one specifying that string)

Though suggestions very welcome ofc

Copy link
Contributor

@mbtools mbtools left a comment

Choose a reason for hiding this comment

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

looks good

@wraithgar wraithgar merged commit fd6479f into npm:latest May 28, 2024
42 checks passed
@github-actions github-actions bot mentioned this pull request May 28, 2024
@davidlj95 davidlj95 deleted the fix-publish-tag-cmd-ref branch May 28, 2024 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants