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: use more clear name in getSystemErrorMessage's example #57310

Conversation

IkumaTadokoro
Copy link
Contributor

In the previous example, name actually points to the message. So I changed this name to fit the context of the example.

Fixes: #57305

In the previous example, `name` actually points to the `message`.
So I changed this name to fit the context of the example.

Fixes: nodejs#57305
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. util Issues and PRs related to the built-in util module. labels Mar 4, 2025
@IkumaTadokoro IkumaTadokoro marked this pull request as ready for review March 4, 2025 12:51
@lpinca lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Mar 4, 2025
@jasnell jasnell added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. fast-track PRs that do not need to wait for 48 hours to land. labels Mar 4, 2025
Copy link
Contributor

github-actions bot commented Mar 4, 2025

Fast-track has been requested by @jasnell. Please 👍 to approve.

@jasnell
Copy link
Member

jasnell commented Mar 4, 2025

There's really no reason to make this one wait the full 48 hours

@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 4, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/57310
✔  Done loading data for nodejs/node/pull/57310
----------------------------------- PR info ------------------------------------
Title      doc: use more clear name in getSystemErrorMessage's example (#57310)
Author     ikuma-t <tadokorodev@gmail.com> (@IkumaTadokoro, first-time contributor)
Branch     IkumaTadokoro:improve-get-system-error-message-example -> nodejs:main
Labels     util, doc, fast-track, author ready
Commits    1
 - doc: use more clear name in getSystemErrorMessage's example
Committers 1
 - ikuma-t <tadokorodev@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/57310
Fixes: https://github.com/nodejs/node/issues/57305
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/57310
Fixes: https://github.com/nodejs/node/issues/57305
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 04 Mar 2025 12:50:25 GMT
   ✔  Approvals: 3
   ✔  - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/57310#pullrequestreview-2657616856
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/57310#pullrequestreview-2658029718
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/57310#pullrequestreview-2658746867
   ℹ  This PR is being fast-tracked
   ✘  This PR needs to wait 40 more hours to land (or 0 hours if there is 1 more approval (👍) of the fast-track request from collaborators).
   ✘  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/13661968166

@geeksilva97 geeksilva97 added commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Mar 4, 2025
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Mar 5, 2025
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/57310
✔  Done loading data for nodejs/node/pull/57310
----------------------------------- PR info ------------------------------------
Title      doc: use more clear name in getSystemErrorMessage's example (#57310)
Author     ikuma-t <tadokorodev@gmail.com> (@IkumaTadokoro, first-time contributor)
Branch     IkumaTadokoro:improve-get-system-error-message-example -> nodejs:main
Labels     util, doc, fast-track, author ready
Commits    1
 - doc: use more clear name in getSystemErrorMessage's example
Committers 1
 - ikuma-t <tadokorodev@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/57310
Fixes: https://github.com/nodejs/node/issues/57305
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/57310
Fixes: https://github.com/nodejs/node/issues/57305
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Tue, 04 Mar 2025 12:50:25 GMT
   ✔  Approvals: 4
   ✔  - Joyee Cheung (@joyeecheung) (TSC): https://github.com/nodejs/node/pull/57310#pullrequestreview-2657616856
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/57310#pullrequestreview-2658029718
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/57310#pullrequestreview-2658746867
   ✔  - Edy Silva (@geeksilva97): https://github.com/nodejs/node/pull/57310#pullrequestreview-2659477548
   ℹ  This PR is being fast-tracked
   ✘  Last GitHub CI failed
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu
https://github.com/nodejs/node/actions/runs/13665753502

@jakecastelli jakecastelli removed the commit-queue-failed An error occurred while landing this pull request using GitHub Actions. label Mar 7, 2025
jakecastelli pushed a commit that referenced this pull request Mar 7, 2025
In the previous example, `name` actually points to the `message`.
So I changed this name to fit the context of the example.

Fixes: #57305
PR-URL: #57310
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com>
@jakecastelli
Copy link
Member

Landed in 8032e96

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggested improvements to the name of the temporary variable in the example of util.getSystemErrorMessage
7 participants