doc: remove usage of you in n-api doc #18528
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
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc.
nodejs-github-bot
added
doc
jasnell
approved these changes
Feb 2, 2018
Trott
reviewed
Feb 2, 2018
doc/api/n-api.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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, usenapi_remove_wrap()first.
cjihrig
approved these changes
Feb 2, 2018
BridgeAR
approved these changes
Feb 3, 2018
gireeshpunathil
approved these changes
Feb 5, 2018
danbev
approved these changes
Feb 5, 2018
|
Pushed commit to address comments. |
|
CI failures are unrelated. Opened #18584 for odroid failure. Going to land. |
|
Landed as 629a447 |
mhdawson
added a commit
that referenced
this pull request
Feb 5, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Feb 21, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Merged
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 12, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: nodejs#18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 16, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: nodejs#18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 16, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. Backport-PR-URL: #19447 PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
May 1, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. Backport-PR-URL: #19265 PR-URL: #18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Merged
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
We avoid using 'you' in the documentation based on our guidelines. Remove usage in the n-api doc. PR-URL: nodejs#18528 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@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.
We avoid using 'you' in the documentation based on our
guidelines. Remove usage in the n-api doc.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc, n-api