doc: add clarification for exception behaviour #25339
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
Refs: nodejs/abi-stable-node#356 Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour.
nodejs-github-bot
added
doc
cjihrig
approved these changes
Jan 4, 2019
Trott
reviewed
Jan 4, 2019
Trott
reviewed
Jan 4, 2019
Trott
reviewed
Jan 4, 2019
Trott
reviewed
Jan 4, 2019
doc/api/n-api.md
Outdated
| called in order to allow for some minimal cleanup to be completed | ||
| before returning to JavaScript. For those functions, `napi_status` | ||
| will reflect the success/error/exception for that function, irrespective of | ||
| whether an exception was pending when the function was called. |
There was a problem hiding this comment.
This sentence is difficult to understand. "for that function" is particularly confusing coming after "for those functions". Maybe try writing it as two shorter sentences or something? Or just tidying up the sentence that's there somehow?
There was a problem hiding this comment.
Maybe something like this?
In that case, `napi_status` will reflect the status for the function.
It will not reflect previous pending exceptions.There was a problem hiding this comment.
(Obviously, change my suggestion if it is factually incorrect. I'm commenting on style and readability, not content.)
There was a problem hiding this comment.
Your suggestion works for me. Updating.
lpinca
approved these changes
Jan 4, 2019
Co-Authored-By: mhdawson <michael_dawson@ca.ibm.com>
Co-Authored-By: mhdawson <michael_dawson@ca.ibm.com>
Co-Authored-By: mhdawson <michael_dawson@ca.ibm.com>
|
@Trott fixed up as per your comments. |
|
Landed in b406c9c. |
danbev
pushed a commit
that referenced
this pull request
Jan 9, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: #25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Jan 14, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: #25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
BridgeAR
pushed a commit
to BridgeAR/node
that referenced
this pull request
Jan 16, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: nodejs#25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
BethGriggs
pushed a commit
that referenced
this pull request
Apr 28, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: #25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
BethGriggs
pushed a commit
that referenced
this pull request
May 10, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: #25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
May 16, 2019
Document current behaviour where some methods can be called when an exception is pending, while others cannot and explain the behaviour. PR-URL: #25339 Refs: nodejs/abi-stable-node#356 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This was referenced May 29, 2019
This was referenced Aug 9, 2020
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.
Refs: nodejs/abi-stable-node#356
Document current behaviour where some methods can be called
when an exception is pending, while others cannot and explain
the behaviour.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes