-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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: overhaul tools/doc/html.js #20613
Closed
vsemozhetbyt
wants to merge
2
commits into
nodejs:master
from
vsemozhetbyt:tools-doc-html.js-overhaul
Closed
tools: overhaul tools/doc/html.js #20613
vsemozhetbyt
wants to merge
2
commits into
nodejs:master
from
vsemozhetbyt:tools-doc-html.js-overhaul
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
Issues and PRs related to the documentations.
tools
Issues and PRs related to the tools directory.
labels
May 8, 2018
vsemozhetbyt
changed the title
Tools doc html.js overhaul
tools: overhaul tools/doc/html.js
May 8, 2018
сс @nodejs/documentation |
trivikr
approved these changes
May 13, 2018
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.
RSLGTM
vsemozhetbyt
added
the
author ready
PRs that have at least one approval, no pending requests for changes, and a CI started.
label
May 13, 2018
vsemozhetbyt
added a commit
that referenced
this pull request
May 14, 2018
PR-URL: #20613 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Landed in 12b0159 |
2 tasks
addaleax
pushed a commit
that referenced
this pull request
May 14, 2018
PR-URL: #20613 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
author ready
PRs that have at least one approval, no pending requests for changes, and a CI started.
doc
Issues and PRs related to the documentations.
tools
Issues and PRs related to the tools directory.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesI was trying to facilitate reviewing this PR as far as I could, singling out changes that refactor monolithic structures or alter doc results (see #20307, #20514, #20552, #20586).
However, this PR still produces big and complicated diff as it has many small changes scattered all over the script and also bears refactoring (simplifying, merging, inlining etc) closely coupled but tracery systems. It would be hard to split these changes into dozens of separate PRs.
To make review even possible, I've split it into 2 commits: local changes + pure reordering of major blocks with no additions/deletions. Please, review these commits separately.
commit 1
Modernize:
Optimize:
toHTML()
andrender()
) to reduce data transferring..includes()
..match()
with.test()
in boolean context.['str', 'str'].join()
with straight string concatenation.new Array(length + 1).join(str)
withstr.repeat(length)
.Clarify:
Commit 2
This PR produces HTML docs identical to the previous ones, reducing the script by ~ 100 lines (with previous 4 PRs, the size is reduced by 175 lines) and I hope the script becomes a bit clearer and simpler.