doc: fix a few n-api doc issues #13650
Closed
Conversation
This file contains hidden or 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
cjihrig
approved these changes
Jun 13, 2017
jasnell
approved these changes
Jun 13, 2017
jasongin
reviewed
Jun 13, 2017
doc/api/n-api.md
Outdated
There was a problem hiding this comment.
This was already fixed in #13570. You'll need to rebase.
jasongin
reviewed
Jun 13, 2017
doc/api/n-api.md
Outdated
jasongin
reviewed
Jun 13, 2017
doc/api/n-api.md
Outdated
There was a problem hiding this comment.
Just noticed - this should say length in bytes, not characters.
There was a problem hiding this comment.
Also fix the doc for the length parameter of napi_create_string_utf16. That length is in two-byte code units, not characters. (GitHub won't let me put a comment on that line.)
jasongin
reviewed
Jun 13, 2017
doc/api/n-api.md
Outdated
There was a problem hiding this comment.
Length in bytes. While in the case of Latin1 a character is always one byte, I think bytes is clearer in case someone is not familiar with the encoding.
RReverser
reviewed
Jun 14, 2017
doc/api/n-api.md
Outdated
RReverser
reviewed
Jun 14, 2017
doc/api/n-api.md
Outdated
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. Fixes: nodejs#13555 Fixes: nodejs#13556 Fixes: nodejs#13562
|
@jasongin, @RReverser thanks for the comments. Rebased and pushed commit to address. |
RReverser
approved these changes
Jun 15, 2017
jasongin
approved these changes
Jun 15, 2017
|
CI run looks ok. Arm failure was unrelated, a problem doing checkout. Going to land. |
|
Landed as 62e940d |
mhdawson
added a commit
that referenced
this pull request
Jun 16, 2017
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. PR-URL: #13650 Fixes: #13555 Fixes: #13556 Fixes: #13562 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]> Reviewed-By: Ingvar Stepanyan <[email protected]>
addaleax
pushed a commit
that referenced
this pull request
Jun 17, 2017
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. PR-URL: #13650 Fixes: #13555 Fixes: #13556 Fixes: #13562 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]> Reviewed-By: Ingvar Stepanyan <[email protected]>
Merged
addaleax
pushed a commit
that referenced
this pull request
Jun 21, 2017
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. PR-URL: #13650 Fixes: #13555 Fixes: #13556 Fixes: #13562 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]> Reviewed-By: Ingvar Stepanyan <[email protected]>
Merged
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 10, 2018
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. PR-URL: nodejs#13650 Fixes: nodejs#13555 Fixes: nodejs#13556 Fixes: nodejs#13562 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]> Reviewed-By: Ingvar Stepanyan <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 16, 2018
- Add doc for napi_create_string_latin1(). - Fix signatures where c string was specified instead of napi_value. - Fix return type of napi_callback. - Update to specify that napi_escape_handle() can only be called once for a given scope. Backport-PR-URL: #19447 PR-URL: #13650 Fixes: #13555 Fixes: #13556 Fixes: #13562 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jason Ginchereau <[email protected]> Reviewed-By: Ingvar Stepanyan <[email protected]>
Merged
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.
for a given scope.
Fixes: #13555
Fixes: #13556
Fixes: #13562
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc, n-api