-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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
update N-API docs #27745
update N-API docs #27745
Conversation
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.
I wonder if we should add another optional information to skip some versions. We could also automate it by checking the release dates of each version. |
@BridgeAR I agree being able to skip versions would be good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hope this does not cause confusion, but with 6.x being EOL I'm willing to give it a try.
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. PR-URL: #27745 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
PR-URL: #27745 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
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. PR-URL: #27745 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
PR-URL: #27745 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
introduced_in
metadataNode.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.
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 #27267 (https://travis-ci.com/nodejs/node/jobs/193473667#L1277).
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 andsetting 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:
node/tools/doc/html.js
Lines 417 to 423 in f4572cc
For the version matrix the non-12.x rows of the N-API version 4 column
should be handled in #27567 (raised by a first time contributor).
cc @nodejs/n-api @nodejs/documentation
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes