doc: change Node.js style to error-first style - #17638
Conversation
Sorry, something went wrong.
|
I think these were the only two files (errors.md and util.md) where Node.js style callback was used, please comment if there are any other places where this change can be made 😄 |
Sorry, something went wrong.
Trott
left a comment
There was a problem hiding this comment.
Looks good to me! Would like it even more if we go further and remove style so it's just error-first callback and not error-first style callback.
Sorry, something went wrong.
There was a problem hiding this comment.
Super-tiny nit here, and I know this was in the original text and not something you introduced, so feel free to ignore this, but it would be good to replace the quotation marks in this line with italics because that's the standard typography for words-as-words. (See https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Text_formatting#Words_as_words for more information if curious.)
Sorry, something went wrong.
There was a problem hiding this comment.
👍 no problem
Sorry, something went wrong.
|
FYI -- triggered CI but Jenkins is being a little weird right now. Don't have a link to paste yet. |
Sorry, something went wrong.
Sorry, something went wrong.
BridgeAR
left a comment
There was a problem hiding this comment.
LGTM even though I would like my comment to be incorporated.
Sorry, something went wrong.
There was a problem hiding this comment.
For historical reasons it would be good to keep a reference to the Node.js style callback as in:
... error-first callback, historically called `Node.js style callback`.
The reason is that e.g. blog posts and other documentations might still call them like this and it would be good to find a explanation even with the new name.
Sorry, something went wrong.
There was a problem hiding this comment.
Rather than historically I'd prefer the simpler and arguably-more-accurate sometimes...
... an _error-first callback_ (sometimes referred to as a _Node.js style callback_) ...
Sorry, something went wrong.
There was a problem hiding this comment.
sounds correct to me as well. Done 👍
Sorry, something went wrong.
We change the awkward "Node.js style callback" phrasing to the more informative "error-first style callback," which is more in line with its usage Refs: nodejs#17593 (comment)
Sorry, something went wrong.
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: #17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
|
Landed in 3db136a. Thanks @ramsgoli! |
Sorry, something went wrong.
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: #17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: #17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: nodejs/node#17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: #17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Change the awkward "Node.js style callback" phrasing to the more informative "error-first callback." PR-URL: #17638 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
We change the awkward "Node.js style callback" phrasing to the
more informative "error-first style callback," which is more
in line with its usage
Refs: #17593 (comment)
Checklist
Affected core subsystem(s)
doc