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.

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

Jump to bottom

Docs (N-API): napi_create_function docs inconsistent #21606

Closed
s-h-a-d-o-w opened this issue Jun 30, 2018 · 0 comments
Closed

Docs (N-API): napi_create_function docs inconsistent #21606

s-h-a-d-o-w opened this issue Jun 30, 2018 · 0 comments
Assignees
@gabrielschulhof
Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Comments

@s-h-a-d-o-w
Copy link

  • Subsystem: N-API

See the description of parameters:
https://github.com/nodejs/node/blob/master/doc/api/n-api.md#napi_create_function
vs.
https://github.com/nodejs/node/blob/master/doc/api/n-api.md#napi_create_function-1

The first one appears to be correct - it takes 6 parameters, not 5.

Might be beneficial to link from one part of the docs to the other, so that you don't have to maintain docs for this function in two places?
@vsemozhetbyt vsemozhetbyt added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jun 30, 2018
@gabrielschulhof gabrielschulhof self-assigned this Jul 2, 2018
@gabrielschulhof gabrielschulhof mentioned this issue Jul 2, 2018
Closed
3 tasks
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this issue Jul 5, 2018
doc: fix doc for napi_create_function
6131981 
Merge the two duplicate entries for `napi_create_function()`.

Fixes: nodejs#21606
targos pushed a commit that referenced this issue Jul 6, 2018
@targos
doc: fix doc for napi_create_function
c8d5bab 
Merge the two duplicate entries for `napi_create_function()`.

Fixes: #21606
PR-URL: #21627
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@snyk-bot snyk-bot mentioned this issue Mar 18, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gabrielschulhof gabrielschulhof

Labels
doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: fix doc for napi_create_function gabrielschulhof/node
3 participants
@gabrielschulhof @vsemozhetbyt @s-h-a-d-o-w