doc: fix missing napi_get_typedarray_info() param #20631
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
nodejs-github-bot
added
doc
cjihrig
approved these changes
May 9, 2018
TimothyGu
approved these changes
May 9, 2018
vsemozhetbyt
reviewed
May 9, 2018
doc/api/n-api.md
Outdated
| @@ -1697,8 +1697,9 @@ napi_status napi_get_typedarray_info(napi_env env, | |||
| - `[in] typedarray`: `napi_value` representing the `TypedArray` whose | |||
| properties to query. | |||
| - `[out] type`: Scalar datatype of the elements within the `TypedArray`. | |||
| - `[out] length`: `Number` of elements in the `TypedArray`. | |||
| - `[out] data`: The data buffer underlying the typed array. | |||
| - `[out] length`: number of elements in the `TypedArray`. | |||
There was a problem hiding this comment.
As all other descriptions begin with upper case, maybe we can just remove backticks around Number or add The before number as in the next lines?
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
vsemozhetbyt
added
the
fast-track
|
As |
gabrielschulhof
force-pushed
the
n-api-typedarray-doc-fix
branch
from
3d10b79 to
c196b75
Compare
|
@vsemozhetbyt AIUI, v6.x is going into maintenance mode, so only the most critical of fixes will be landed there. |
Also, make the type name notation more consistent.
gabrielschulhof
force-pushed
the
n-api-typedarray-doc-fix
branch
from
c196b75 to
0c2cd5e
Compare
|
@vsemozhetbyt I went with "The number of elements..." |
jasnell
approved these changes
May 9, 2018
vsemozhetbyt
approved these changes
May 9, 2018
vsemozhetbyt
added
the
author ready
|
Landed in 06dc96f. |
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
May 9, 2018
Also, make the type name notation more consistent. PR-URL: nodejs#20631 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
targos
pushed a commit
that referenced
this pull request
May 12, 2018
Also, make the type name notation more consistent. PR-URL: #20631 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
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.
Also, make the type name notation more consistent.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes