doc: update tools/doc/README.md#20047
Uh oh!
There was an error while loading. Please reload this page.
Conversation
vsemozhetbyt added the fast-track 
nodejs-github-bot added doc 
vsemozhetbyt commented Apr 15, 2018
vsemozhetbyt commented Apr 15, 2018
Fixed my own typo. |
richardlau left a comment
richardlau left a comment There was a problem hiding this comment.
Looks okay, but IMHO this file could really do with some work -- it's basically one example but without explanations of things like the YAML metadata (e.g., REPLACEME). Maybe some sort of reconciliation with https://github.com/nodejs/node/blob/master/doc/STYLE_GUIDE.md for another PR (tools/doc is not the first place I'd look for guidance on writing documentation)?
@richardlau I usually dare to do some cleansing in docs, but not so much of writing, as my English is clumsy. So this task may be better left for somebody from @nodejs/documentation with better language skills. I am just afraid to do major doc refactoring or create rather long text) |
tools/doc/README.md Outdated
There was a problem hiding this comment.
Is there a reason behind this reordering?
The existing one is sorted in alphabetical order.
There was a problem hiding this comment.
I mean some logical hierarchy: from parent structures to child components mentioned in the previous lines. If this is not clear, I can revert this fragment,
There was a problem hiding this comment.
Classes and Functions go together, in most languages classes contain functions but in JavaScript everything is a function at the end.
Alphabetical order might be better.
vsemozhetbyt commented Apr 15, 2018
Alphabetical order restored. |
BridgeAR added the author ready 
vsemozhetbyt commented Apr 16, 2018
Landed in 9f6742d |
PR-URL: #20047 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
PR-URL: #20047 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
PR-URL: nodejs#20047 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
PR-URL: #20047 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
8 participants
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes