-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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: add JSDoc to os module functions #38197
Closed
Closed
Conversation
This file contains 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
PRs that need a full CI run.
os
Issues and PRs related to the os subsystem.
labels
Apr 11, 2021
cc @bmeck |
bmeck
reviewed
Apr 12, 2021
bmeck
reviewed
Apr 12, 2021
bmeck
approved these changes
Apr 12, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, after nits on the parameters
add param types Co-authored-by: Bradley Farias <bradley.meck@gmail.com>
Ah, good catch! Sorry about that. |
targos
reviewed
Apr 13, 2021
targos
reviewed
Apr 13, 2021
Co-authored-by: Michaël Zasso <targos@protonmail.com>
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
benjamingr
approved these changes
Apr 14, 2021
jasnell
added
author ready
PRs that have at least one approval, no pending requests for changes, and a CI started.
and removed
needs-ci
PRs that need a full CI run.
labels
Apr 16, 2021
jasnell
approved these changes
Apr 16, 2021
mhdawson
approved these changes
Apr 16, 2021
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
targos
pushed a commit
that referenced
this pull request
Apr 18, 2021
PR-URL: #38197 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
Landed in d97787f |
targos
pushed a commit
that referenced
this pull request
May 1, 2021
PR-URL: #38197 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
Merged
danielleadams
pushed a commit
that referenced
this pull request
May 8, 2021
PR-URL: #38197 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
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.
os
Issues and PRs related to the os subsystem.
typings
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.
Inspired by @bmeck: https://twitter.com/bradleymeck/status/1380643627211354115
I only pulled in actual docs if it seemed relevant, but can add more. It seemed redundant to copy the docs wholesale, but I can!
I also wasn't sure what the preferred style for types was with regards to
x[]
vsArray<x>
, so I went with the recommended array-simple mode oftypescript-eslint
.Some screenshots: