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.

Sign up for GitHub

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

Jump to bottom

Suggested improvements to the name of the temporary variable in the example of util.getSystemErrorMessage #57305

Closed
IkumaTadokoro opened this issue Mar 4, 2025 · 1 comment
Closed

Suggested improvements to the name of the temporary variable in the example of util.getSystemErrorMessage #57305

IkumaTadokoro opened this issue Mar 4, 2025 · 1 comment
Labels
doc Issues and PRs related to the documentations.

Comments

@IkumaTadokoro
Copy link
Contributor

Affected URL(s)

https://nodejs.org/api/util.html#utilgetsystemerrormessageerr

Description of the problem

The sample code for util.getSystemErrorMessage is shown below.

fs.access('file/that/does/not/exist', (err) => {
  const name = util.getSystemErrorMessage(err.errno);
  console.error(name);  // No such file or directory
});

The usage and result of this example is correct. But the name actually points to the message. The temporary variable in this example has the same name as util.getSystemErrorName. Therefore, changing name to message would clarify the documentation.

If this suggestion is OK, I will create a PullRequest.
@IkumaTadokoro IkumaTadokoro added the doc Issues and PRs related to the documentations. label Mar 4, 2025
@IkumaTadokoro IkumaTadokoro changed the title Suggested improvements to the name of temporary variable in the sample Suggested improvements to the name of the temporary variable in the example of util.getSystemErrorMessage Mar 4, 2025
@joyeecheung
Copy link
Member

SGTM, PR welcomed :)

IkumaTadokoro added a commit to IkumaTadokoro/node that referenced this issue Mar 4, 2025
@IkumaTadokoro
doc: use more clear name in getSystemErrorMessage's example
c183605 
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
@IkumaTadokoro IkumaTadokoro mentioned this issue Mar 4, 2025
Closed
aduh95 pushed a commit that referenced this issue Mar 9, 2025
@IkumaTadokoro @aduh95
doc: use more clear name in getSystemErrorMessage's example
78dafe9 
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>
aduh95 pushed a commit that referenced this issue Mar 9, 2025
@IkumaTadokoro @aduh95
doc: use more clear name in getSystemErrorMessage's example
4e438c3 
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>
RafaelGSS pushed a commit that referenced this issue Apr 1, 2025
@IkumaTadokoro @RafaelGSS
doc: use more clear name in getSystemErrorMessage's example
d49cd3d 
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>
RafaelGSS pushed a commit that referenced this issue Apr 1, 2025
@IkumaTadokoro @RafaelGSS
doc: use more clear name in getSystemErrorMessage's example
330907a 
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>
aduh95 pushed a commit that referenced this issue Apr 2, 2025
@IkumaTadokoro @aduh95
doc: use more clear name in getSystemErrorMessage's example
40d81f4 
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>
aduh95 pushed a commit that referenced this issue Apr 3, 2025
@IkumaTadokoro @aduh95
doc: use more clear name in getSystemErrorMessage's example
969d69e 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: use more clear name in getSystemErrorMessage's example IkumaTadokoro/node
2 participants
@joyeecheung @IkumaTadokoro