doc: promisify of method without last argument #17573
Closed
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
BridgeAR
reviewed
Dec 9, 2017
doc/api/util.md
Outdated
| behavior if it does not. | ||
| final argument in all cases unless a non function is passed or the passed | ||
| function's `promisify.custom` is a non function in which case it throws. | ||
| if the passed function's last argument is not a node style callback - it will |
There was a problem hiding this comment.
@BridgeAR : thanks. I've fixed that. Kindly review now!
Trott
reviewed
Dec 10, 2017
| @@ -552,8 +552,11 @@ If there is an `original[util.promisify.custom]` property present, `promisify` | |||
| will return its value, see [Custom promisified functions][]. | |||
|
|
|||
| `promisify()` assumes that `original` is a function taking a callback as its | |||
| final argument in all cases, and the returned function will result in undefined | |||
| behavior if it does not. | |||
| final argument in all cases unless a non function is passed or the passed | |||
| final argument in all cases, and the returned function will result in undefined | ||
| behavior if it does not. | ||
| final argument in all cases unless a non function is passed or the passed | ||
| function's `promisify.custom` is a non function in which case it throws. |
| behavior if it does not. | ||
| final argument in all cases unless a non function is passed or the passed | ||
| function's `promisify.custom` is a non function in which case it throws. | ||
| If the passed function's last argument is not a node style callback - it will |
| final argument in all cases unless a non function is passed or the passed | ||
| function's `promisify.custom` is a non function in which case it throws. | ||
| If the passed function's last argument is not a node style callback - it will | ||
| treat it 'as if' its last argument is a node style callback - and will pass one |
|
To me this whole new block feels really awkwardly worded. @Trott's suggestions will help but to me the whole sentence structure and flow is just really off. I'll think on how to re-word. |
|
@apapirovski @Trott : Closing this as I'll have someone else pick this up who would want to work on |
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.
Updated the documentation for
util#promisfybehaviour as fix to #17569Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc