Skip to content
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

doc: remove usage of you in n-api doc #18528

Closed
wants to merge 2 commits into from
Closed

doc: remove usage of you in n-api doc #18528

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7530d94
doc: remove usage of you in n-api doc
mhdawson Feb 2, 2018
3cded13
squash: address comments
mhdawson Feb 5, 2018
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
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 @@ -3148,7 +3148,7 @@ Afterward, additional manipulation of the wrapper's prototype chain may cause

*Note*: Calling `napi_wrap()` a second time on an object that already has a
native instance associated with it by virtue of a previous call to
`napi_wrap()` will cause an error to be returned. If you wish to associate
`napi_wrap()` will cause an error to be returned. In order to associate
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Get rid of In order:

To associate another native instance with the given object...

Nit: Consider getting rid of *Note*: at the start of this paragraph.

Nit: Get rid of that already has a native instance associated with it by virtue of a previous call to `napi_wrap()`. The sentence already says a second time and adding all that wordy context just makes it confusing. Also s/cause an error to be returned/return an error/. Also s/given//. Also.... Aw heck, here's what I think this whole too-long paragraph should be reduced to:

Calling napi_wrap() a second time on an object will return an error. To associate
another native instance with the object, use napi_remove_wrap() first.

another native instance with the given object, call `napi_remove_wrap()` on it
first.

Expand Down