Skip to content

tools: fix comment nits in tools/doc/*.js files - #19696

Closed
vsemozhetbyt wants to merge 3 commits into
nodejs:masterfrom
vsemozhetbyt:tools-doc-comments
Closed

tools: fix comment nits in tools/doc/*.js files#19696
vsemozhetbyt wants to merge 3 commits into
nodejs:masterfrom
vsemozhetbyt:tools-doc-comments

Conversation

@vsemozhetbyt

Copy link
Copy Markdown
Contributor
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
  • 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.

* 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.
@vsemozhetbytvsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Mar 30, 2018
@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Mar 30, 2018
@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Comment threadtools/doc/html.js Outdated
}

//XXX maybe put more stuff here?
//XXX Maybe put more stuff here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: being on it, you might also change XXX to TODO.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

@vsemozhetbytvsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 30, 2018
Comment threadtools/doc/html.js Outdated
}

// 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

macOS since we're changing this line?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

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>
@vsemozhetbyt

Copy link
Copy Markdown
ContributorAuthor

Landed in b88477e

@vsemozhetbyt
vsemozhetbyt deleted the tools-doc-comments branch March 30, 2018 13:11
@vsemozhetbytvsemozhetbyt changed the title tools: Fix comment nits in tools/doc/*.js filestools: fix comment nits in tools/doc/*.js filesMar 30, 2018
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>
@targostargos mentioned this pull request Apr 4, 2018
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>
@MylesBorinsMylesBorins mentioned this pull request Aug 17, 2018
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.fast-trackPRs that do not need to wait for 48 hours to land.toolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@vsemozhetbyt@Leko@richardlau@BridgeAR@MylesBorins@nodejs-github-bot