lib: fix and improve os JSDoc typings #38316
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
needs-ci
1. marked optional params as such 2. assigned default values using jsdoc conventions.
jasnell
approved these changes
Apr 20, 2021
marsonya
added
the
author ready
Leko
approved these changes
Apr 24, 2021
This comment has been minimized.
This comment has been minimized.
Collaborator
Member
|
Landed in 00b6fee |
jasnell
pushed a commit
that referenced
this pull request
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
pushed a commit
that referenced
this pull request
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
pushed a commit
that referenced
this pull request
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
pushed a commit
that referenced
this pull request
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
pushed a commit
that referenced
this pull request
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
pushed a commit
that referenced
this pull request
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
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: