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

lib: fix and improve os JSDoc typings #38316

Closed
wants to merge 1 commit into from

Conversation

@marsonya
Copy link
Member

@marsonya marsonya commented Apr 20, 2021

We add JSDoc comments in lib files to help core developers. I feel it would be important for core developers to know whether a param is optional and what it's default value is.

This PR makes the following changes in lib/os.js:

  • marked optional params as such
  • assigned default values using JSDoc conventions.
1. marked optional params as such
2. assigned default values using jsdoc conventions.
Leko
Leko approved these changes Apr 24, 2021
@nodejs-github-bot

This comment has been hidden.

@nodejs-github-bot
Copy link
Contributor

@nodejs-github-bot nodejs-github-bot commented Apr 26, 2021

@jasnell
Copy link
Member

@jasnell jasnell commented Apr 26, 2021

Landed in 00b6fee

@jasnell jasnell closed this Apr 26, 2021
jasnell added a commit that referenced this issue Apr 26, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
targos added a commit that referenced this issue Apr 29, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
@targos targos mentioned this pull request May 3, 2021
targos added a commit that referenced this issue May 30, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
targos added a commit that referenced this issue Jun 5, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
targos added a commit that referenced this issue Jun 5, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
targos added a commit that referenced this issue Jun 11, 2021
1. marked optional params as such
2. assigned default values using jsdoc conventions.

PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants