doc: update promisify() docs with behavior when bad arguments are passed #17593
Conversation
This file contains 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
nodejs-github-bot
added
doc
ramsgoli
changed the title
apapirovski
approved these changes
Dec 10, 2017
doc/api/util.md
Outdated
| behavior if it does not. | ||
| final argument in all cases. If `original` is not a function, `promisify()` | ||
| will throw an error. If `original` is a function but its last argument is not a | ||
| node-style callback, it will be still be passed a node-style callback as its last |
There was a problem hiding this comment.
I think we tend to refer to these as "Node.js style callback".
doc/api/util.md
Outdated
| final argument in all cases. If `original` is not a function, `promisify()` | ||
| will throw an error. If `original` is a function but its last argument is not a | ||
| node-style callback, it will be still be passed a node-style callback as its last | ||
| argument anyways. |
There was a problem hiding this comment.
the "anyways" shouldn't be necessary here.
Trott
reviewed
Dec 10, 2017
doc/api/util.md
Outdated
| behavior if it does not. | ||
| final argument in all cases. If `original` is not a function, `promisify()` | ||
| will throw an error. If `original` is a function but its last argument is not a | ||
| Node.js style callback, it will be still be passed a Node.js style callback as its last |
There was a problem hiding this comment.
If you or someone else would like a good second pull request after this one lands, I'd be all for getting rid of the awkward and non-obvious Node.js style callback terminology here and in errors.md and replacing it with error-first callback which is more informative, less awkward, and probably more in line with usage outside of our docs.
There was a problem hiding this comment.
Nit: long line, please add a line break at 80 chars. Also there seems to be a redundant "be"?
Trott
approved these changes
Dec 10, 2017
BridgeAR
approved these changes
Dec 11, 2017
benjamingr
approved these changes
Dec 11, 2017
maclover7
approved these changes
Dec 11, 2017
cjihrig
approved these changes
Dec 12, 2017
lpinca
approved these changes
Dec 12, 2017
doc/api/util.md
Outdated
| behavior if it does not. | ||
| final argument in all cases. If `original` is not a function, `promisify()` | ||
| will throw an error. If `original` is a function but its last argument is not a | ||
| Node.js style callback, it will be still be passed a Node.js style callback as its last |
There was a problem hiding this comment.
Nit: long line, please add a line break at 80 chars. Also there seems to be a redundant "be"?
Currently the documentation states that promisify() will result in undefined behavior if bad arguments are passed. This is not necessarily the case, since the behavior is well defined, but just not useful. Fixes: nodejs#17569 (comment)
ramsgoli
force-pushed
the
doc-promisify-update
branch
from
dee6aba
to
e215574
Compare
|
@lpinca whoops, my bad! just noticed those details. Thanks for pointing them out! 👍 |
apapirovski
added
the
author ready
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
Dec 12, 2017
Currently the documentation states that promisify() will result in undefined behavior if bad arguments are passed. This is not necessarily the case, since the behavior is well defined, but just not useful. PR-URL: nodejs#17593 Fixes: nodejs#17569 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
|
Landed in 031d01b |
|
@ramsgoli just as a note - I fixed the commit message as it did not comply to our guidelines (that you ticket off while opening the PR). The commit message and the general line length was to long. |
|
@BridgeAR ah, thank you so much for the reminder! I need to be sure to pay attention to all the details of the guidelines next time. Thanks again 🙌 |
|
Sure thing. I just thought it is best to provide a short feedback so I have less work when landing your next PR 😄 |
2 tasks
addaleax
removed
the
author ready
ramsgoli
added a commit
to ramsgoli/node
that referenced
this pull request
Dec 13, 2017
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)
MylesBorins
pushed a commit
that referenced
this pull request
Jan 8, 2018
Currently the documentation states that promisify() will result in undefined behavior if bad arguments are passed. This is not necessarily the case, since the behavior is well defined, but just not useful. PR-URL: #17593 Fixes: #17569 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Jan 22, 2018
Currently the documentation states that promisify() will result in undefined behavior if bad arguments are passed. This is not necessarily the case, since the behavior is well defined, but just not useful. PR-URL: #17593 Fixes: #17569 Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Jon Moss <me@jonathanmoss.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently the documentation states that promisify() will result in
undefined behavior if bad arguments are passed. This is not necessarily
the case, since the behavior is well defined, but just not useful.
Fixes: #17569
Checklist
Affected core subsystem(s)
doc