Obvious, adding return type to util.promisify(), but valid update to …#16040
Obvious, adding return type to util.promisify(), but valid update to …#16040SupaMic wants to merge 1 commit intonodejs:masterfrom
Conversation
…documentation for my first commit
nodejs-github-bot
added
doc
| --> | ||
|
|
||
| * `original` {Function} | ||
| Returns: {Function} a promise style function |
There was a problem hiding this comment.
It is somewhat inconsistent throughout this documentation how we do this but most cases use the star to better outline the return value.
There was a problem hiding this comment.
See the end of the Style Guide: https://github.com/nodejs/node/blob/master/doc/STYLE_GUIDE.md
There was a problem hiding this comment.
"promise style function" doesn't really work in this regard, either this should be just {Function} as the return type or the "original" line should be expanded as well.
Trott
added
the
code-and-learn
There was a problem hiding this comment.
LGTM with @gibfahn's and @benjamingr's comments addressed.
That is: * Returns: {Function}
|
Landed in 9c44215 Thanks for the PR, and congratulations on becoming a Node.js Contributor 🎉 ! |
PR-URL: #16040 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: #16040 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs/node#16040 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs/node#16040 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
8 participants
adding return type to util.promisify()
Checklist
Affected core subsystem(s)
doc