-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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: update marked dependency #6396
Conversation
@nodejs/documentation |
@@ -8,6 +8,15 @@ var typeParser = require('./type-parser.js'); | |||
|
|||
module.exports = toHTML; | |||
|
|||
// customized heading without id attribute | |||
var renderer = new marked.Renderer(); |
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.
const
?
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.
Wouldn't really fit the style of this file. I guess we shoul to es6ify the doctool later.
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.
Two lines below this, template strings are used :P
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.
Yes it's a problem. I think I'd better change the template string to string replace (edit: or just string add) in order to keep the style consistent.
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.
fwiw, I also used template strings in #6495, I don’t really think that’s a problem. And sorry for the merge conflict, btw, but that should be limited to the package.json.
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.
It doesn't matter. I rebased upstream and resolved the conflict.
I just changed the template to string add before I saw your latest comment :D
I think either is OK. At least the style is consistent now. We can es6ify it later.
Let's see if the doctool tests pass: |
7343c52
to
062bdf2
Compare
Probably nothing to worry about, I bet it'll be green next run. Here's another run:https://ci.nodejs.org/job/node-test-pull-request/2523/ LGTM, by the way. |
CI is red, example failure: https://ci.nodejs.org/job/node-test-commit-arm/3159/nodes=armv7-wheezy/tapTestReport/test.tap-1068/ That’s just whitespace changes in the test results, though. It may be nice to do something there like we do for the HTML output tests, i.e. strip whitespaces in both expected and actual output and compare that. |
fad0eac
to
d3ceaa8
Compare
Update module marked. Customize renderer to remove id from heading.
d3ceaa8
to
c3208bc
Compare
@addaleax It's my bad. I modified the test case to make my local tests pass but forgot to commit it. It's updated now. I just removed extra |
LGTM pending CI: https://ci.nodejs.org/job/node-test-commit/3215/ |
CI is green. @firedfox the |
Oh yes, please change the |
Landed in 3f69ea5. Thanks! You can set this via |
Update module marked. Customize renderer to remove id from heading. PR-URL: #6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
FYI, this PR looks to be breaking I'm going to look into what's causing the breakage but if I can't figure it out or it's too much effort to fix, I'll be moving to revert it. |
@bnoordhuis addaleax/node@6e4342f seems to do the trick? |
@addaleax Yes, seems to be working. |
Update module marked. Customize renderer to remove id from heading. PR-URL: #6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Update module marked. Customize renderer to remove id from heading. PR-URL: nodejs#6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Update module marked. Customize renderer to remove id from heading. PR-URL: #6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Update module marked. Customize renderer to remove id from heading. PR-URL: #6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Update module marked. Customize renderer to remove id from heading. PR-URL: #6396 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Checklist
Affected core subsystem(s)
tools
Description of change
Update module
tools/doc/node_modules/marked
. Customize renderer to remove id from heading.Diff result for all.html http://106.187.89.52/tmp/diff-683f2a7-doc-html-all.html
Diff result for all.json http://106.187.89.52/tmp/diff-683f2a7-doc-json-all.html
The newly updated marked module fixed several problems in the doc.
Removed unnecessary
</p><p>
In
addons.md
:HTML result from:
to:
Fixed unordered list
In
util.md
:HTML result from:
to:
Removed redundant new lines
In
addons.md
:HTML result from:
to:
code element class name changes
It changed the class name for
code
element fromcpp / js / javascript
tolang-cpp / lang-js / lang-javascript
. It does not matter because there is no style defined for these class names.