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: add JSDoc to os module functions #38197

Closed
wants to merge 3 commits into from
Closed

lib: add JSDoc to os module functions #38197

wants to merge 3 commits into from

Conversation

xavdid
Copy link
Contributor

@xavdid xavdid commented Apr 11, 2021

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[] vs Array<x>, so I went with the recommended array-simple mode of typescript-eslint.

Some screenshots:

@nodejs-github-bot 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
@benjamingr
Copy link
Member

cc @bmeck

@targos targos added the typings label Apr 11, 2021
lib/os.js Show resolved Hide resolved
lib/os.js Show resolved Hide resolved
Copy link
Member

@bmeck bmeck left a 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>
@xavdid
Copy link
Contributor Author

xavdid commented Apr 12, 2021

Ah, good catch! Sorry about that.

lib/os.js Outdated Show resolved Hide resolved
lib/os.js Outdated Show resolved Hide resolved
Co-authored-by: Michaël Zasso <targos@protonmail.com>
@targos targos self-assigned this Apr 14, 2021
@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot

This comment has been minimized.

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 16, 2021

@jasnell 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
Copy link
Member

@mhdawson mhdawson left a 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>
@targos
Copy link
Member

targos commented Apr 18, 2021

Landed in d97787f

@targos targos closed this Apr 18, 2021
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>
@danielleadams danielleadams mentioned this pull request May 3, 2021
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>
@xavdid xavdid deleted the xavdid-types-os branch May 23, 2021 17:45
@targos targos removed their assignment Oct 31, 2021
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants