-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
tools: adds doc links to the stability index reference #11664
Conversation
I think that the commit message should be |
Thanks - updated to be |
cc @nodejs/documentation |
I don't think this file is exercised by any tests, but it is covered by lint rules, so here's a CI lint run for it: https://ci.nodejs.org/job/node-test-linter/7386/ |
tools/doc/html.js
Outdated
text = text.replace( | ||
STABILITY_TEXT_REG_EXP, | ||
'<pre class="api_stability api_stability_$2">$1 $2$3</pre>' | ||
`<pre class="${classNames}"><a href="${docsUrl}">$1 $2</a>$3 |
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.
Nit: I would prefer writing this as,
`<pre class="${classNames}">
<a href="${docsUrl}">$1 $2</a>$3
</pre>`
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've updated to bring the closing </pre>
to the same line, but I can't write it nested the way you have it because of the default formatting of a <pre>
tag. Doing it the way you had it adds another 20px-ish left padding into the bar.
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html.
Thanks. Landed in dd76f5f |
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: #11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. PR-URL: nodejs/node#11664 Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Checklist
make -j4 test
(UNIX)Affected core subsystem(s)
tools
Description of Change
This modifies the script that generates the docs to create a static link from each Stability Index callout bar to the Stability Index explanations in documentation.html. This was a first-commit request from @Trott. Here is what he pitched to me:
I looked for any precedent for styling, and the best I could find is that when features are deprecated, a simple link is put to the new API to use, inside the banner. This similarly just links the first part (e.g. Stability: 2) to the documentation.html page. I'm obviously open to other styling suggestions, but this seemed the most straightforward. There doesn't seem to be any precedent in the docs for other things like a
?
icon or similar.Also I'm just linking to the main anchor for the Stability Index explanations, rather than to a specific one. My thinking here is that there are only a handful of them, and they should all fit nicely above the fold for anyone reading that page. It didn't seem necessary to create additional anchors.
Note that I had to make a couple more variables in the commit here to make the tests pass with the 80 character line limit.