Skip to content

doc: add clarification for exception behaviour #25339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mhdawson wants to merge 6 commits into from
Closed

doc: add clarification for exception behaviour #25339

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79bc97c
doc: add clarification for exception behaviour
mhdawson Jan 4, 2019
9b16424
Update doc/api/n-api.md
Trott Jan 7, 2019
b4783ca
squash: accept suggestion
Trott Jan 7, 2019
73fa299
squash: accept suggestion
Trott Jan 7, 2019
450ee9c
squash: address comments
mhdawson Jan 7, 2019
39b0ca3
squash: fixup line formatting after changes.
mhdawson Jan 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update doc/api/n-api.md 
Co-Authored-By: mhdawson <michael_dawson@ca.ibm.com>
  • Loading branch information
@Trott @mhdawson
Trott and mhdawson authored Jan 7, 2019
commit 9b164244158f95abfb8e057eae9409ffa2db854f
2 changes: 1 addition & 1 deletion doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ 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.
Copy link
Copy Markdown
Member

@Trott Trott Jan 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Member

@Trott Trott Jan 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something like this?

In that case, `napi_status` will reflect the status for the function.
It will not reflect previous pending exceptions.

Copy link
Copy Markdown
Member

@Trott Trott Jan 4, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Obviously, change my suggestion if it is factually incorrect. I'm commenting on style and readability, not content.)

Copy link
Copy Markdown
Member Author

@mhdawson mhdawson Jan 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your suggestion works for me. Updating.

In order to avoid confusion it is important to check the
To avoid confusion, check the
error status after every function call.

When an exception is pending one of two approaches can be employed.
Expand Down