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

doc: fix documentation for --run #53976

Merged
merged 2 commits into from
Jul 22, 2024
Merged

Conversation

RedYetiDev
Copy link
Member

Fixes #53944

@nodejs-github-bot nodejs-github-bot added cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. labels Jul 20, 2024
doc/api/cli.md Outdated
@@ -2017,7 +2017,7 @@ changes:
> Stability: 1.2 - Release candidate

This runs a specified command from a package.json's `"scripts"` object.
If no `"command"` is provided, it will list the available scripts.
If an invalid `"command"` is provided, it will list the available scripts.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If an invalid `"command"` is provided, it will list the available scripts.
If a missing `"command"` is provided, it will list the available scripts.

Copy link
Member

Choose a reason for hiding this comment

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

I think "invalid" is better. node --run is still missing a command so it is not different from the original wording.

Copy link
Member

Choose a reason for hiding this comment

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

How about "If there is not a matching "command", it will list the available scripts."?

Co-authored-by: Yagiz Nizipli <yagiz@nizipli.com>
@RedYetiDev RedYetiDev added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Jul 20, 2024
@anonrig anonrig added the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 21, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jul 22, 2024
@nodejs-github-bot nodejs-github-bot merged commit 4b8000c into nodejs:main Jul 22, 2024
19 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 4b8000c

targos pushed a commit that referenced this pull request Jul 28, 2024
PR-URL: #53976
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Jul 30, 2024
RafaelGSS pushed a commit that referenced this pull request Aug 5, 2024
PR-URL: #53976
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@targos targos added the dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. label Sep 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Issues and PRs related to the Node.js command line interface. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

node: --run requires an argument
7 participants