FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

lib: add JSDoc to os module functions by xavdid · Pull Request #38197 · nodejs/node · GitHub

/ node Public

lib: add JSDoc to os module functions - #38197

Closed
xavdid wants to merge 3 commits into
nodejs:masterfrom
xavdid:xavdid-types-os
Closed

lib: add JSDoc to os module functions#38197
xavdid wants to merge 3 commits into
nodejs:masterfrom
xavdid:xavdid-types-os

Conversation

xavdid commented Apr 11, 2021

Copy link
Copy Markdown
Contributor

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 added needs-ci PRs that need a full CI run. os Issues and PRs related to the os subsystem. labels Apr 11, 2021

Copy link
Copy Markdown
Member

cc @bmeck

targos added the typings label Apr 11, 2021
Comment thread lib/os.js
Comment thread lib/os.js

bmeck left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, after nits on the parameters

add param types

Co-authored-by: Bradley Farias <bradley.meck@gmail.com>

xavdid commented Apr 12, 2021

Copy link
Copy Markdown
Contributor Author

Ah, good catch! Sorry about that.

Comment thread lib/os.js Outdated
Comment thread lib/os.js Outdated
Co-authored-by: Michaël Zasso <targos@protonmail.com>
targos self-assigned this Apr 14, 2021

This comment has been minimized.

This comment has been minimized.

nodejs-github-bot commented Apr 16, 2021
edited by jasnell
Loading

Copy link
Copy Markdown
Collaborator

jasnell added author ready PRs that have at least one approval, no outstanding review comments, and a CI started. and removed needs-ci PRs that need a full CI run. labels Apr 16, 2021

mhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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 commented Apr 18, 2021

Copy link
Copy Markdown
Member

Landed in d97787f

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 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 deleted the xavdid-types-os branch May 23, 2021 17:45
targos removed their assignment Oct 31, 2021
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
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 outstanding review comments, 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


Back | FazBrowse Home | New Git URL