Skip to content

update N-API docs

Rodrigo Muino Tomonari requested to merge github/fork/richardlau/n-api-docs into master
  • doc,n-api: fix introduced_in metadata Node.js v7.10.0 did not contain N-API. Update the introduced_in metadata to prevent a broken 7.x "View another version" link in the N-API docs.
  • doc,n-api: update N-API version matrix for v12.x

The first commit ("fix introduced_in metadata") fixes a 404 not found link (https://nodejs.org/docs/latest-v7.x/api/n-api.html) which was disovered in https://github.com/nodejs/node/pull/27267 (https://travis-ci.com/nodejs/node/jobs/193473667#L1277). image

As seen in the version matrix, N-API was backported to Node.js 6. I set introduced_in for v8.0.0 based on Node.js 6 being End-of-Life and setting to a 6.x release would still result in the broken link to 7.x due to the simplistic way the "View another version" links are generated: https://github.com/nodejs/node/blob/f4572cc088bc3fd7e360983a579e95e768d200e9/tools/doc/html.js#L417-L423

For the version matrix the non-12.x rows of the N-API version 4 column should be handled in https://github.com/nodejs/node/pull/27567 (raised by a first time contributor).

cc @nodejs/n-api @nodejs/documentation

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Merge request reports