-
Notifications
You must be signed in to change notification settings - Fork 30k
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
os: fix cpus
invalid return type jsdoc syntax
#43006
Conversation
himself65
commented
May 8, 2022
Fast-track has been requested by @himself65. Please 👍 to approve. |
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.
This syntax is used in a couple of other places too, like
Lines 331 to 336 in 58d8d69
* @returns {{ | |
* uid: number | |
* gid: number | |
* username: string | |
* homedir: string | |
* shell: string | null |
Lines 304 to 314 in 58d8d69
// JSDoc recommended rules that we disable | |
'jsdoc/require-jsdoc': 'off', | |
'jsdoc/require-param-description': 'off', | |
'jsdoc/newline-after-description': 'off', | |
'jsdoc/require-returns-description': 'off', | |
'jsdoc/valid-types': 'off', | |
'jsdoc/no-undefined-types': 'off', | |
'jsdoc/require-param': 'off', | |
'jsdoc/check-tag-names': 'off', | |
'jsdoc/require-returns': 'off', | |
'jsdoc/require-property-description': 'off', |
08110f4
to
075b04f
Compare
fixed |
I ran the So I don't think we should enable the jsdoc type check for now For example: /Users/himself65/Code/node/lib/util.js
85:1 warning Syntax error in type: arg is boolean jsdoc/valid-types
94:1 warning Syntax error in type: arg is null jsdoc/valid-types
103:1 warning Syntax error in type: arg is (null | undefined) jsdoc/valid-types
112:1 warning Syntax error in type: arg is number jsdoc/valid-types
120:1 warning Syntax error in type: arg is string jsdoc/valid-types
129:1 warning Syntax error in type: arg is symbol jsdoc/valid-types
138:1 warning Syntax error in type: arg is undefined jsdoc/valid-types
147:1 warning Syntax error in type: a is NonNullable<object> jsdoc/valid-types
156:1 warning Syntax error in type: arg is Error jsdoc/valid-types
165:1 warning Syntax error in type: arg is Function jsdoc/valid-types
174:1 warning Syntax error in type: arg is (boolean | null | number | string | symbol | undefined) jsdoc/valid-types
209:1 warning Syntax error in type: (...args: any[]) => void jsdoc/valid-types
259:1 warning Syntax error in type: S extends null ? T : (T & S) jsdoc/valid-types
285:1 warning @template should not have a bracketed type in "jsdoc" mode jsdoc/valid-types
287:1 warning Syntax error in type: T extends (...args: infer TArgs) => Promise<infer TReturn> ?
((...params: [...TArgs, ((err: Error, ret: TReturn) => any)]) => void) :
never
jsdoc/valid-types |
I check the we should set settings: {
jsdoc: {
mode: 'typescript'
}
}, |
If the problem is about adding one more revision to the git blame, I think we could still do the change and add the commit to the cc @targos since you mentioned the |
* model: string, | ||
* speed: number, |
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.
I have a personal preference of using ;
in type definitions, but I'm fine with ,
if we already use it elsewhere.
I've opened a new issue that discusses whether enable |
Commit Queue failed- Loading data for nodejs/node/pull/43006 ✔ Done loading data for nodejs/node/pull/43006 ----------------------------------- PR info ------------------------------------ Title os: fix `cpus` invalid return type jsdoc syntax (#43006) Author Himself65 (@Himself65) Branch Himself65:20220508-fix-jsdoc -> nodejs:master Labels os, fast-track, author ready, needs-ci, typings Commits 2 - os: fix `cpus` invalid return type jsdoc syntax - fixup!os: fix `cpus` invalid return type jsdoc syntax Committers 1 - Himself65 PR-URL: https://github.com/nodejs/node/pull/43006 Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/43006 Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen -------------------------------------------------------------------------------- ℹ This PR was created on Sun, 08 May 2022 05:08:56 GMT ✔ Approvals: 2 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/43006#pullrequestreview-966523299 ✔ - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/43006#pullrequestreview-967159779 ℹ This PR is being fast-tracked ✖ The fast-track request requires at least two collaborators' approvals (👍). ✖ Last GitHub CI failed ✖ No Jenkins CI runs detected -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/2303698988 |
Landed in d62e412 |
PR-URL: #43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
PR-URL: #43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
PR-URL: #43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
PR-URL: #43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
PR-URL: #43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
PR-URL: nodejs/node#43006 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>