tools: fix comment nits in tools/doc/*.js files #19696
Closed
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
* Unify first letters case. * Unify periods. * Delete excess spaces. * Add some blank lines as logical delimiters. * Remove obvious comments. * Combine short lines, rewrap lines more logically. * Fix typos.
vsemozhetbyt
added
the
fast-track
nodejs-github-bot
added
doc
BridgeAR
approved these changes
Mar 30, 2018
tools/doc/html.js
Outdated
| @@ -446,7 +446,7 @@ function linkJsTypeDocs(text) { | |||
| } | |||
| } | |||
|
|
|||
| //XXX maybe put more stuff here? | |||
| // XXX Maybe put more stuff here? | |||
There was a problem hiding this comment.
Suggestion: being on it, you might also change XXX to TODO.
vsemozhetbyt
added
the
author ready
Leko
approved these changes
Mar 30, 2018
richardlau
reviewed
Mar 30, 2018
tools/doc/html.js
Outdated
| @@ -408,17 +408,17 @@ function parseYAML(text) { | |||
| return html.join('\n'); | |||
| } | |||
|
|
|||
| // Syscalls which appear in the docs, but which only exist in BSD / OSX | |||
| // Syscalls which appear in the docs, but which only exist in BSD / OSX. | |||
There was a problem hiding this comment.
macOS since we're changing this line?
richardlau
approved these changes
Mar 30, 2018
vsemozhetbyt
added a commit
that referenced
this pull request
Mar 30, 2018
* Unify first letters case. * Unify periods. * Delete excess spaces. * Add some blank lines as logical delimiters. * Remove obvious comments. * Combine short lines, rewrap lines more logically. * Fix typos. * "XXX" -> "TODO:", OSX -> macOS. PR-URL: #19696 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
|
Landed in b88477e |
vsemozhetbyt
changed the title
2 tasks
targos
pushed a commit
that referenced
this pull request
Apr 2, 2018
* Unify first letters case. * Unify periods. * Delete excess spaces. * Add some blank lines as logical delimiters. * Remove obvious comments. * Combine short lines, rewrap lines more logically. * Fix typos. * "XXX" -> "TODO:", OSX -> macOS. PR-URL: #19696 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Aug 17, 2018
* Unify first letters case. * Unify periods. * Delete excess spaces. * Add some blank lines as logical delimiters. * Remove obvious comments. * Combine short lines, rewrap lines more logically. * Fix typos. * "XXX" -> "TODO:", OSX -> macOS. PR-URL: #19696 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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) passes