benchmark,doc,lib,test: capitalize comments

PR-URL: https://github.com/nodejs/node/pull/26483
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>

benchmark/_cli.js

@@ -65,7 +65,7 @@ function CLI(usage, settings) {
       // item arguments
       this.items.push(arg);
 
-      // the next value must be an item
+      // The next value must be an item
       mode = 'item';
     } else {
       // Bad case, abort

benchmark/net/net-c2s-cork.js

@@ -1,4 +1,4 @@
-// test the speed of .pipe() with sockets
+// Test the speed of .pipe() with sockets
 'use strict';
 
 const common = require('../common.js');
@@ -78,7 +78,7 @@ Writer.prototype.write = function(chunk, encoding, cb) {
   return true;
 };
 
-// doesn't matter, never emits anything.
+// Doesn't matter, never emits anything.
 Writer.prototype.on = function() {};
 Writer.prototype.once = function() {};
 Writer.prototype.emit = function() {};

benchmark/net/net-c2s.js

@@ -1,4 +1,4 @@
-// test the speed of .pipe() with sockets
+// Test the speed of .pipe() with sockets
 'use strict';
 
 const common = require('../common.js');
@@ -72,7 +72,7 @@ Writer.prototype.write = function(chunk, encoding, cb) {
   return true;
 };
 
-// doesn't matter, never emits anything.
+// Doesn't matter, never emits anything.
 Writer.prototype.on = function() {};
 Writer.prototype.once = function() {};
 Writer.prototype.emit = function() {};

benchmark/net/net-pipe.js

@@ -1,4 +1,4 @@
-// test the speed of .pipe() with sockets
+// Test the speed of .pipe() with sockets
 'use strict';
 
 const common = require('../common.js');
@@ -75,7 +75,7 @@ Writer.prototype.write = function(chunk, encoding, cb) {
   return true;
 };
 
-// doesn't matter, never emits anything.
+// Doesn't matter, never emits anything.
 Writer.prototype.on = function() {};
 Writer.prototype.once = function() {};
 Writer.prototype.emit = function() {};

benchmark/net/net-s2c.js

@@ -1,4 +1,4 @@
-// test the speed of .pipe() with sockets
+// Test the speed of .pipe() with sockets
 'use strict';
 
 const common = require('../common.js');
@@ -73,7 +73,7 @@ Writer.prototype.write = function(chunk, encoding, cb) {
   return true;
 };
 
-// doesn't matter, never emits anything.
+// Doesn't matter, never emits anything.
 Writer.prototype.on = function() {};
 Writer.prototype.once = function() {};
 Writer.prototype.emit = function() {};

benchmark/net/net-wrap-js-stream-passthrough.js

@@ -68,7 +68,7 @@ Writer.prototype.write = function(chunk, encoding, cb) {
   return true;
 };
 
-// doesn't matter, never emits anything.
+// Doesn't matter, never emits anything.
 Writer.prototype.on = function() {};
 Writer.prototype.once = function() {};
 Writer.prototype.emit = function() {};

benchmark/net/tcp-raw-s2c.js

@@ -5,9 +5,9 @@
 const common = require('../common.js');
 const util = require('util');
 
-// if there are dur=N and len=N args, then
+// If there are dur=N and len=N args, then
 // run the function with those settings.
-// if not, then queue up a bunch of child processes.
+// If not, then queue up a bunch of child processes.
 const bench = common.createBenchmark(main, {
   len: [102400, 1024 * 1024 * 16],
   type: ['utf', 'asc', 'buf'],

benchmark/run.js

@@ -50,7 +50,7 @@ if (format === 'csv') {
     for (const key of Object.keys(data.conf)) {
       conf += ` ${key}=${JSON.stringify(data.conf[key])}`;
     }
-    // delete first space of the configuration
+    // Delete first space of the configuration
     conf = conf.slice(1);
     if (format === 'csv') {
       // Escape quotes (") for correct csv formatting

benchmark/timers/immediate.js

@@ -57,7 +57,7 @@ function depth1(N) {
   }
 }
 
-// concurrent setImmediate, 0 arguments
+// Concurrent setImmediate, 0 arguments
 function breadth(N) {
   var n = 0;
   bench.start();
@@ -71,7 +71,7 @@ function breadth(N) {
   }
 }
 
-// concurrent setImmediate, 1 argument
+// Concurrent setImmediate, 1 argument
 function breadth1(N) {
   var n = 0;
   bench.start();
@@ -85,7 +85,7 @@ function breadth1(N) {
   }
 }
 
-// concurrent setImmediate, 4 arguments
+// Concurrent setImmediate, 4 arguments
 function breadth4(N) {
   N /= 2;
   var n = 0;

doc/api/cluster.md

@@ -237,7 +237,7 @@ if (cluster.isMaster) {
     res.writeHead(200);
     res.end('hello world\n');
 
-    // notify master about the request
+    // Notify master about the request
     process.send({ cmd: 'notifyRequest' });
   }).listen(8000);
 }

doc/api/dgram.md

@@ -27,7 +27,7 @@ server.on('listening', () => {
 });
 
 server.bind(41234);
-// server listening 0.0.0.0:41234
+// Prints: server listening 0.0.0.0:41234
 ```
 
 ## Class: dgram.Socket
@@ -172,7 +172,7 @@ server.on('listening', () => {
 });
 
 server.bind(41234);
-// server listening 0.0.0.0:41234
+// Prints: server listening 0.0.0.0:41234
 ```
 
 ### socket.bind(options[, callback])

doc/api/domain.md

@@ -420,7 +420,7 @@ d.on('error', (er) => {
 });
 d.run(() => {
   process.nextTick(() => {
-    setTimeout(() => { // simulating some various async stuff
+    setTimeout(() => { // Simulating some various async stuff
       fs.open('non-existent file', 'r', (er, fd) => {
         if (er) throw er;
         // proceed...

doc/api/errors.md

@@ -158,7 +158,7 @@ const fs = require('fs');
 
 try {
   fs.readFile('/some/file/that/does-not-exist', (err, data) => {
-    // mistaken assumption: throwing here...
+    // Mistaken assumption: throwing here...
     if (err) {
       throw err;
     }
@@ -217,7 +217,7 @@ a string representing the location in the code at which
 ```js
 const myObject = {};
 Error.captureStackTrace(myObject);
-myObject.stack;  // similar to `new Error().stack`
+myObject.stack;  // Similar to `new Error().stack`
 ```
 
 The first line of the trace will be prefixed with
@@ -316,7 +316,7 @@ will not be present in the stack traces:
 const cheetahify = require('./native-binding.node');
 
 function makeFaster() {
-  // cheetahify *synchronously* calls speedy.
+  // `cheetahify()` *synchronously* calls speedy.
   cheetahify(function speedy() {
     throw new Error('oh no!');
   });

doc/api/fs.md

@@ -1911,7 +1911,7 @@ console.log(fs.readFileSync('temp.txt', 'utf8'));
 // get the file descriptor of the file to be truncated
 const fd = fs.openSync('temp.txt', 'r+');
 
-// truncate the file to first four bytes
+// Truncate the file to first four bytes
 fs.ftruncate(fd, 4, (err) => {
   assert.ifError(err);
   console.log(fs.readFileSync('temp.txt', 'utf8'));
@@ -3912,7 +3912,7 @@ async function doTruncate() {
     await filehandle.truncate(4);
   } finally {
     if (filehandle) {
-      // close the file if it is opened.
+      // Close the file if it is opened.
       await filehandle.close();
     }
   }
@@ -3939,7 +3939,7 @@ async function doTruncate() {
     await filehandle.truncate(10);
   } finally {
     if (filehandle) {
-      // close the file if it is opened.
+      // Close the file if it is opened.
       await filehandle.close();
     }
   }

doc/api/http.md

@@ -373,7 +373,7 @@ proxy.on('connect', (req, cltSocket, head) => {
 // now that proxy is running
 proxy.listen(1337, '127.0.0.1', () => {
 
-  // make a request to a tunneling proxy
+  // Make a request to a tunneling proxy
   const options = {
     port: 1337,
     host: '127.0.0.1',
@@ -387,7 +387,7 @@ proxy.listen(1337, '127.0.0.1', () => {
   req.on('connect', (res, socket, head) => {
     console.log('got connected!');
 
-    // make a request over an HTTP tunnel
+    // Make a request over an HTTP tunnel
     socket.write('GET / HTTP/1.1\r\n' +
                  'Host: www.google.com:80\r\n' +
                  'Connection: close\r\n' +
@@ -1313,7 +1313,7 @@ with any headers passed to [`response.writeHead()`][], with the headers passed
 to [`response.writeHead()`][] given precedence.
 
 ```js
-// returns content-type = text/plain
+// Returns content-type = text/plain
 const server = http.createServer((req, res) => {
   res.setHeader('Content-Type', 'text/html');
   res.setHeader('X-Foo', 'bar');
@@ -1506,7 +1506,7 @@ desired with potential future retrieval and modification, use
 [`response.setHeader()`][] instead.
 
 ```js
-// returns content-type = text/plain
+// Returns content-type = text/plain
 const server = http.createServer((req, res) => {
   res.setHeader('Content-Type', 'text/html');
   res.setHeader('X-Foo', 'bar');
@@ -1918,7 +1918,7 @@ http.get('http://nodejs.org/dist/index.json', (res) => {
   }
   if (error) {
     console.error(error.message);
-    // consume response data to free up memory
+    // Consume response data to free up memory
     res.resume();
     return;
   }

doc/api/http2.md

@@ -3138,7 +3138,7 @@ with any headers passed to [`response.writeHead()`][], with the headers passed
 to [`response.writeHead()`][] given precedence.
 
 ```js
-// returns content-type = text/plain
+// Returns content-type = text/plain
 const server = http2.createServer((req, res) => {
   res.setHeader('Content-Type', 'text/html');
   res.setHeader('X-Foo', 'bar');
@@ -3332,7 +3332,7 @@ with any headers passed to [`response.writeHead()`][], with the headers passed
 to [`response.writeHead()`][] given precedence.
 
 ```js
-// returns content-type = text/plain
+// Returns content-type = text/plain
 const server = http2.createServer((req, res) => {
   res.setHeader('Content-Type', 'text/html');
   res.setHeader('X-Foo', 'bar');

doc/api/inspector.md

@@ -171,7 +171,7 @@ session.post('Profiler.enable', () => {
 
     // some time later...
     session.post('Profiler.stop', (err, { profile }) => {
-      // write profile to disk, upload, etc.
+      // Write profile to disk, upload, etc.
       if (!err) {
         fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile));
       }

doc/api/modules.md

@@ -921,7 +921,7 @@ added: v10.12.0
 const { createRequireFromPath } = require('module');
 const requireUtil = createRequireFromPath('../src/utils');
 
-// require `../src/utils/some-tool`
+// Require `../src/utils/some-tool`
 requireUtil('./some-tool');
 ```
 

doc/api/net.md

@@ -132,7 +132,7 @@ const server = net.createServer((socket) => {
   throw err;
 });
 
-// grab an arbitrary unused port.
+// Grab an arbitrary unused port.
 server.listen(() => {
   console.log('opened server on', server.address());
 });

doc/api/perf_hooks.md

@@ -331,7 +331,7 @@ const {
 } = require('perf_hooks');
 
 const obs = new PerformanceObserver((list, observer) => {
-  // Called three times synchronously. list contains one item
+  // Called three times synchronously. `list` contains one item.
 });
 obs.observe({ entryTypes: ['mark'] });
 
@@ -346,7 +346,7 @@ const {
 } = require('perf_hooks');
 
 const obs = new PerformanceObserver((list, observer) => {
-  // called once. list contains three items
+  // Called once. `list` contains three items.
 });
 obs.observe({ entryTypes: ['mark'], buffered: true });
 

doc/api/process.md

@@ -1286,7 +1286,7 @@ setTimeout(() => {
   // [ 1, 552 ]
 
   console.log(`Benchmark took ${diff[0] * NS_PER_SEC + diff[1]} nanoseconds`);
-  // benchmark took 1000000552 nanoseconds
+  // Benchmark took 1000000552 nanoseconds
 }, 1000);
 ```
 

doc/api/readline.md

@@ -457,7 +457,7 @@ For instance: `[[substr1, substr2, ...], originalsubstring]`.
 function completer(line) {
   const completions = '.help .error .exit .quit .q'.split(' ');
   const hits = completions.filter((c) => c.startsWith(line));
-  // show all completions if none found
+  // Show all completions if none found
   return [hits.length ? hits : completions, line];
 }
 ```

doc/api/stream.md

@@ -256,8 +256,8 @@ function writeOneMillionTimes(writer, data, encoding, callback) {
         // last time!
         writer.write(data, encoding, callback);
       } else {
-        // see if we should continue, or wait
+        // See if we should continue, or wait.
-        // don't pass the callback, because we're not done yet.
+        // Don't pass the callback, because we're not done yet.
         ok = writer.write(data, encoding);
       }
     } while (i > 0 && ok);
@@ -418,7 +418,7 @@ const fs = require('fs');
 const file = fs.createWriteStream('example.txt');
 file.write('hello, ');
 file.end('world!');
-// writing more now is not allowed!
+// Writing more now is not allowed!
 ```
 
 ##### writable.setDefaultEncoding(encoding)
@@ -819,7 +819,7 @@ cause some amount of data to be read into an internal buffer.
 ```javascript
 const readable = getReadableStreamSomehow();
 readable.on('readable', function() {
-  // there is some data to read now
+  // There is some data to read now
   let data;
 
   while (data = this.read()) {
@@ -2431,7 +2431,7 @@ net.createServer((socket) => {
     socket.end('The message was received but was not processed.\n');
   });
 
-  // start the flow of data, discarding it.
+  // Start the flow of data, discarding it.
   socket.resume();
 }).listen(1337);
 ```

lib/_http_agent.js

@@ -162,7 +162,7 @@ Agent.prototype.addRequest = function addRequest(req, options, port/* legacy */,
   var sockLen = freeLen + this.sockets[name].length;
 
   if (freeLen) {
-    // we have a free socket, so use that.
+    // We have a free socket, so use that.
     var socket = this.freeSockets[name].shift();
     // Guard against an uninitialized or user supplied Socket.
     if (socket._handle && typeof socket._handle.asyncReset === 'function') {
@@ -357,7 +357,7 @@ function setRequestSocket(agent, req, socket) {
     return;
   }
   socket.setTimeout(req.timeout);
-  // reset timeout after response end
+  // Reset timeout after response end
   req.once('response', (res) => {
     res.once('end', () => {
       if (socket.timeout !== agentTimeout) {

lib/_http_common.js

@@ -147,7 +147,7 @@ function parserOnMessageComplete() {
     stream.push(null);
   }
 
-  // force to read the next incoming message
+  // Force to read the next incoming message
   readStart(parser.socket);
 }
 

lib/_http_server.js

@@ -605,7 +605,7 @@ function resOnFinish(req, res, socket, state, server) {
       state.keepAliveTimeoutSet = true;
     }
   } else {
-    // start sending the next message
+    // Start sending the next message
     var m = state.outgoing.shift();
     if (m) {
       m.assignSocket(socket);

lib/_stream_duplex.js

@@ -124,7 +124,7 @@ Object.defineProperty(Duplex.prototype, 'destroyed', {
     return this._readableState.destroyed && this._writableState.destroyed;
   },
   set(value) {
-    // we ignore the value if the stream
+    // We ignore the value if the stream
     // has not been initialized yet
     if (this._readableState === undefined ||
         this._writableState === undefined) {

lib/_stream_readable.js

@@ -190,7 +190,7 @@ Object.defineProperty(Readable.prototype, 'destroyed', {
     return this._readableState.destroyed;
   },
   set(value) {
-    // we ignore the value if the stream
+    // We ignore the value if the stream
     // has not been initialized yet
     if (!this._readableState) {
       return;
@@ -600,7 +600,7 @@ function maybeReadMore_(stream, state) {
     debug('maybeReadMore read 0');
     stream.read(0);
     if (len === state.length)
-      // didn't get any data, stop spinning.
+      // Didn't get any data, stop spinning.
       break;
   }
   state.readingMore = false;
@@ -741,7 +741,7 @@ Readable.prototype.pipe = function(dest, pipeOpts) {
     src.unpipe(dest);
   }
 
-  // tell the dest that it's being piped to
+  // Tell the dest that it's being piped to
   dest.emit('pipe', src);
 
   // Start the flow if it hasn't been started already.
@@ -793,7 +793,7 @@ Readable.prototype.unpipe = function(dest) {
     return this;
   }
 
-  // slow case. multiple pipe destinations.
+  // Slow case with multiple pipe destinations.
 
   if (!dest) {
     // remove all.
@@ -896,7 +896,7 @@ function updateReadableListening(self) {
     // the upcoming resume will not flow.
     state.flowing = true;
 
-    // crude way to check if we should resume
+    // Crude way to check if we should resume
   } else if (self.listenerCount('data') > 0) {
     self.resume();
   }
@@ -1008,7 +1008,7 @@ Readable.prototype.wrap = function(stream) {
     }
   }
 
-  // proxy certain important events.
+  // Proxy certain important events.
   for (var n = 0; n < kProxyEvents.length; n++) {
     stream.on(kProxyEvents[n], this.emit.bind(this, kProxyEvents[n]));
   }
@@ -1070,7 +1070,7 @@ Object.defineProperty(Readable.prototype, 'readableFlowing', {
   }
 });
 
-// exposed for testing purposes only.
+// Exposed for testing purposes only.
 Readable._fromList = fromList;
 
 Object.defineProperty(Readable.prototype, 'readableLength', {
@@ -1096,7 +1096,7 @@ function fromList(n, state) {
   if (state.objectMode)
     ret = state.buffer.shift();
   else if (!n || n >= state.length) {
-    // read it all, truncate the list
+    // Read it all, truncate the list
     if (state.decoder)
       ret = state.buffer.join('');
     else if (state.buffer.length === 1)

lib/_stream_writable.js

@@ -434,7 +434,7 @@ function onwriteError(stream, state, sync, er, cb) {
     cb(er);
     stream._writableState.errorEmitted = true;
     errorOrDestroy(stream, er);
-    // this can emit finish, but finish must
+    // This can emit finish, but finish must
     // always follow error
     finishMaybe(stream, state);
   }
@@ -589,7 +589,7 @@ Writable.prototype.end = function(chunk, encoding, cb) {
     this.uncork();
   }
 
-  // ignore unnecessary end() calls.
+  // Ignore unnecessary end() calls.
   if (!state.ending)
     endWritable(this, state, cb);
 
@@ -697,7 +697,7 @@ Object.defineProperty(Writable.prototype, 'destroyed', {
     return this._writableState.destroyed;
   },
   set(value) {
-    // we ignore the value if the stream
+    // We ignore the value if the stream
     // has not been initialized yet
     if (!this._writableState) {
       return;

lib/dgram.js

@@ -294,7 +294,7 @@ Socket.prototype.bind = function(port_, address_ /* , callback */) {
       });
     } else {
       if (!state.handle)
-        return; // handle has been closed in the mean time
+        return; // Handle has been closed in the mean time
 
       const err = state.handle.bind(ip, port || 0, flags);
       if (err) {

lib/domain.js

@@ -279,7 +279,7 @@ Domain.prototype.exit = function() {
   var index = stack.lastIndexOf(this);
   if (index === -1) return;
 
-  // exit all domains until this one.
+  // Exit all domains until this one.
   stack.splice(index);
 
   exports.active = stack[stack.length - 1];
@@ -294,7 +294,7 @@ Domain.prototype.add = function(ee) {
   if (ee.domain === this)
     return;
 
-  // has a domain already - remove it first.
+  // Has a domain already - remove it first.
   if (ee.domain)
     ee.domain.remove(ee);
 

lib/fs.js

@@ -368,7 +368,7 @@ function readFileSync(path, options) {
     } while (bytesRead !== 0 && pos < size);
   } else {
     do {
-      // the kernel lies about many files.
+      // The kernel lies about many files.
       // Go ahead and try to read some bytes.
       buffer = Buffer.allocUnsafe(8192);
       bytesRead = tryReadSync(fd, isUserFd, buffer, 0, 8192);
@@ -1445,7 +1445,7 @@ function realpathSync(p, options) {
   const knownHard = Object.create(null);
   const original = p;
 
-  // current character position in p
+  // Current character position in p
   let pos;
   // The partial path so far, including a trailing slash if any
   let current;
@@ -1512,7 +1512,7 @@ function realpathSync(p, options) {
         continue;
       }
 
-      // read the link if it wasn't read before
+      // Read the link if it wasn't read before
       // dev/ino always return 0 on windows, so skip the check.
       let linkTarget = null;
       let id;
@@ -1537,7 +1537,7 @@ function realpathSync(p, options) {
       if (!isWindows) seenLinks[id] = linkTarget;
     }
 
-    // resolve the link, then start over
+    // Resolve the link, then start over
     p = pathModule.resolve(resolvedLink, p.slice(pos));
 
     // Skip over roots
@@ -1585,7 +1585,7 @@ function realpath(p, options, callback) {
   const seenLinks = Object.create(null);
   const knownHard = Object.create(null);
 
-  // current character position in p
+  // Current character position in p
   let pos;
   // The partial path so far, including a trailing slash if any
   let current;
@@ -1611,7 +1611,7 @@ function realpath(p, options, callback) {
   // Walk down the path, swapping out linked path parts for their real
   // values
   function LOOP() {
-    // stop if scanned past end of path
+    // Stop if scanned past end of path
     if (pos >= p.length) {
       return callback(null, encodeRealpathResult(p, options));
     }
@@ -1651,9 +1651,9 @@ function realpath(p, options, callback) {
       return process.nextTick(LOOP);
     }
 
-    // stat & read the link if not read before
+    // Stat & read the link if not read before.
-    // call gotTarget as soon as the link target is known
+    // Call `gotTarget()` as soon as the link target is known.
-    // dev/ino always return 0 on windows, so skip the check.
+    // `dev`/`ino` always return 0 on windows, so skip the check.
     let id;
     if (!isWindows) {
       const dev = stats.dev.toString(32);
@@ -1680,7 +1680,7 @@ function realpath(p, options, callback) {
   }
 
   function gotResolvedLink(resolvedLink) {
-    // resolve the link, then start over
+    // Resolve the link, then start over
     p = pathModule.resolve(resolvedLink, p.slice(pos));
     current = base = splitRoot(p);
     pos = current.length;

lib/internal/child_process.js

@@ -97,7 +97,7 @@ const handleConversion = {
       if (!socket._handle)
         return;
 
-      // if the socket was created by net.Server
+      // If the socket was created by net.Server
       if (socket.server) {
         // The worker should keep track of the socket
         message.key = socket.server._connectionKey;
@@ -169,7 +169,7 @@ const handleConversion = {
       // If the socket was created by net.Server we will track the socket
       if (message.key) {
 
-        // add socket to connections list
+        // Add socket to connections list
         var socketList = getSocketList('got', this, message.key);
         socketList.add({
           socket: socket
@@ -562,7 +562,7 @@ function setupChannel(target, channel) {
     }
   };
 
-  // object where socket lists will live
+  // Object where socket lists will live
   channel.sockets = { got: {}, send: {} };
 
   // handlers will go through this
@@ -670,7 +670,7 @@ function setupChannel(target, channel) {
       options = { swallowErrors: options };
     }
 
-    // package messages with a handle object
+    // Package messages with a handle object
     if (handle) {
       // This message will be handled by an internalMessage event handler
       message = {

lib/internal/fs/utils.js

@@ -393,7 +393,7 @@ function toUnixTimestamp(time, name = 'time') {
     return time;
   }
   if (util.isDate(time)) {
-    // convert to 123.456 UNIX timestamp
+    // Convert to 123.456 UNIX timestamp
     return time.getTime() / 1000;
   }
   throw new ERR_INVALID_ARG_TYPE(name, ['Date', 'Time in seconds'], time);

lib/internal/fs/watchers.js

@@ -118,7 +118,7 @@ function FSWatcher() {
       if (this._handle !== null) {
         // We don't use this.close() here to avoid firing the close event.
         this._handle.close();
-        this._handle = null;  // make the handle garbage collectable
+        this._handle = null;  // Make the handle garbage collectable
       }
       const error = errors.uvException({
         errno: status,
@@ -186,7 +186,7 @@ FSWatcher.prototype.close = function() {
     return;
   }
   this._handle.close();
-  this._handle = null;  // make the handle garbage collectable
+  this._handle = null;  // Make the handle garbage collectable
   process.nextTick(emitCloseNT, this);
 };
 

lib/internal/http2/compat.js

@@ -130,7 +130,7 @@ function onStreamEnd() {
 }
 
 function onStreamError(error) {
-  // this is purposefully left blank
+  // This is purposefully left blank
   //
   // errors in compatibility mode are
   // not forwarded to the request

lib/internal/http2/core.js

@@ -1729,7 +1729,7 @@ class Http2Stream extends Duplex {
     this.emit('timeout');
   }
 
-  // true if the HEADERS frame has been sent
+  // True if the HEADERS frame has been sent
   get headersSent() {
     return !!(this[kState].flags & STREAM_FLAGS_HEADERS_SENT);
   }
@@ -1739,7 +1739,7 @@ class Http2Stream extends Duplex {
     return !!(this[kState].flags & STREAM_FLAGS_ABORTED);
   }
 
-  // true if dealing with a HEAD request
+  // True if dealing with a HEAD request
   get headRequest() {
     return !!(this[kState].flags & STREAM_FLAGS_HEAD_REQUEST);
   }

lib/internal/modules/cjs/loader.js

@@ -341,7 +341,7 @@ Module._findPath = function(request, paths, isMain) {
       }
 
       if (!filename) {
-        // try it with each of the extensions
+        // Try it with each of the extensions
         if (exts === undefined)
           exts = Object.keys(Module._extensions);
         filename = tryExtensions(basePath, exts, isMain);
@@ -384,7 +384,7 @@ var nmLen = nmChars.length;
 if (isWindows) {
   // 'from' is the __dirname of the module.
   Module._nodeModulePaths = function(from) {
-    // guarantee that 'from' is absolute.
+    // Guarantee that 'from' is absolute.
     from = path.resolve(from);
 
     // note: this approach *only* works when the path is guaranteed
@@ -428,7 +428,7 @@ if (isWindows) {
 } else { // posix
   // 'from' is the __dirname of the module.
   Module._nodeModulePaths = function(from) {
-    // guarantee that 'from' is absolute.
+    // Guarantee that 'from' is absolute.
     from = path.resolve(from);
     // Return early not only to avoid unnecessary work, but to *avoid* returning
     // an array of two items for a root: [ '//node_modules', '/node_modules' ]
@@ -850,7 +850,7 @@ Module._extensions['.node'] = function(module, filename) {
     const moduleURL = pathToFileURL(filename);
     manifest.assertIntegrity(moduleURL, content);
   }
-  // be aware this doesn't use `content`
+  // Be aware this doesn't use `content`
   return process.dlopen(module, path.toNamespacedPath(filename));
 };
 

lib/internal/readline.js

@@ -244,7 +244,7 @@ function* emitKeys(stream) {
          */
         const cmdStart = s.length - 1;
 
-        // skip one or two leading digits
+        // Skip one or two leading digits
         if (ch >= '0' && ch <= '9') {
           s += (ch = yield);
 
@@ -386,7 +386,7 @@ function* emitKeys(stream) {
       // carriage return
       key.name = 'return';
     } else if (ch === '\n') {
-      // enter, should have been called linefeed
+      // Enter, should have been called linefeed
       key.name = 'enter';
     } else if (ch === '\t') {
       // tab

lib/internal/stream_base_commons.js

@@ -173,7 +173,7 @@ function onStreamRead(arrayBuffer) {
     return stream.destroy(errnoException(nread, 'read'));
   }
 
-  // defer this until we actually emit end
+  // Defer this until we actually emit end
   if (stream._readableState.endEmitted) {
     if (stream[kMaybeDestroy])
       stream[kMaybeDestroy]();
@@ -181,7 +181,7 @@ function onStreamRead(arrayBuffer) {
     if (stream[kMaybeDestroy])
       stream.on('end', stream[kMaybeDestroy]);
 
-    // push a null to signal the end of data.
+    // Push a null to signal the end of data.
     // Do it before `maybeDestroy` for correct order of events:
     // `end` -> `close`
     stream.push(null);

lib/internal/streams/async_iterator.js

@@ -85,10 +85,9 @@ const ReadableStreamAsyncIteratorPrototype = Object.setPrototypeOf({
       });
     }
 
-    // if we have multiple next() calls
+    // If we have multiple next() calls we will wait for the previous Promise to
-    // we will wait for the previous Promise to finish
+    // finish. This logic is optimized to support for await loops, where next()
-    // this logic is optimized to support for await loops,
+    // is only called once at a time.
-    // where next() is only called once at a time
     const lastPromise = this[kLastPromise];
     let promise;
 
@@ -96,7 +95,7 @@ const ReadableStreamAsyncIteratorPrototype = Object.setPrototypeOf({
       promise = new Promise(wrapForNext(lastPromise, this));
     } else {
       // Fast path needed to support multiple this.push()
-      // without triggering the next() queue
+      // without triggering the next() queue.
       const data = this[kStream].read();
       if (data !== null) {
         return Promise.resolve(createIterResult(data, false));
@@ -136,7 +135,7 @@ const createReadableStreamAsyncIterator = (stream) => {
       value: stream._readableState.endEmitted,
       writable: true
     },
-    // the function passed to new Promise
+    // The function passed to new Promise
     // is cached so we avoid allocating a new
     // closure at every run
     [kHandlePromise]: {

lib/net.js

@@ -510,7 +510,7 @@ Socket.prototype._read = function(n) {
     debug('_read wait for connection');
     this.once('connect', () => this._read(n));
   } else if (!this._handle.reading) {
-    // not already reading, start the flow
+    // Not already reading, start the flow
     debug('Socket._read readStart');
     this._handle.reading = true;
     var err = this._handle.readStart();
@@ -1024,7 +1024,7 @@ Socket.prototype.unref = function() {
 function afterConnect(status, handle, req, readable, writable) {
   var self = handle[owner_symbol];
 
-  // callback may come after call to destroy
+  // Callback may come after call to destroy
   if (self.destroyed) {
     return;
   }

lib/readline.js

@@ -769,7 +769,7 @@ Interface.prototype._moveCursor = function(dx) {
 
   var newPos = this._getCursorPos();
 
-  // check if cursors are in the same line
+  // Check if cursors are in the same line
   if (oldPos.rows === newPos.rows) {
     var diffCursor = this.cursor - oldcursor;
     var diffWidth;
@@ -838,11 +838,11 @@ Interface.prototype._ttyWrite = function(s, key) {
         }
         break;
 
-      case 'u': // delete from current to start of line
+      case 'u': // Delete from current to start of line
         this._deleteLineLeft();
         break;
 
-      case 'k': // delete from current to end of line
+      case 'k': // Delete from current to end of line
         this._deleteLineRight();
         break;
 
@@ -902,12 +902,12 @@ Interface.prototype._ttyWrite = function(s, key) {
         }
         break;
 
-      case 'w': // delete backwards to a word boundary
+      case 'w': // Delete backwards to a word boundary
       case 'backspace':
         this._deleteWordLeft();
         break;
 
-      case 'delete': // delete forward to a word boundary
+      case 'delete': // Delete forward to a word boundary
         this._deleteWordRight();
         break;
 
@@ -937,7 +937,7 @@ Interface.prototype._ttyWrite = function(s, key) {
         this._deleteWordRight();
         break;
 
-      case 'backspace': // delete backwards to a word boundary
+      case 'backspace': // Delete backwards to a word boundary
         this._deleteWordLeft();
         break;
     }
@@ -973,7 +973,7 @@ Interface.prototype._ttyWrite = function(s, key) {
         break;
 
       case 'left':
-        // obtain the code point to the left
+        // Obtain the code point to the left
         this._moveCursor(-charLengthLeft(this.line, this.cursor));
         break;
 

lib/sys.js

@@ -21,9 +21,8 @@
 
 'use strict';
 
-// the sys module was renamed to 'util'.
+// The sys module was renamed to 'util'. This shim remains to keep old programs
-// this shim remains to keep old programs working.
+// working. `sys` is deprecated and shouldn't be used.
-// sys is deprecated and shouldn't be used
 
 module.exports = require('util');
 process.emitWarning('sys is deprecated. Use util instead.',

lib/url.js

@@ -80,12 +80,12 @@ const unsafeProtocol = new SafeSet([
   'javascript',
   'javascript:'
 ]);
-// protocols that never have a hostname.
+// Protocols that never have a hostname.
 const hostlessProtocol = new SafeSet([
   'javascript',
   'javascript:'
 ]);
-// protocols that always contain a // bit.
+// Protocols that always contain a // bit.
 const slashedProtocol = new SafeSet([
   'http',
   'http:',
@@ -367,7 +367,7 @@ Url.prototype.parse = function parse(url, parseQueryString, slashesDenoteHost) {
     if (this.hostname.length > hostnameMaxLen) {
       this.hostname = '';
     } else {
-      // hostnames are always lower case.
+      // Hostnames are always lower case.
       this.hostname = this.hostname.toLowerCase();
     }
 
@@ -396,8 +396,8 @@ Url.prototype.parse = function parse(url, parseQueryString, slashesDenoteHost) {
     }
   }
 
-  // now rest is set to the post-host stuff.
+  // Now rest is set to the post-host stuff.
-  // chop off any delim chars.
+  // Chop off any delim chars.
   if (!unsafeProtocol.has(lowerProto)) {
     // First, make 100% sure that any "autoEscape" chars get
     // escaped, even if encodeURIComponent doesn't think they
@@ -810,7 +810,7 @@ Url.prototype.resolveObject = function resolveObject(relative) {
     result.search = relative.search;
     result.query = relative.query;
     srcPath = relPath;
-    // fall through to the dot-handling below.
+    // Fall through to the dot-handling below.
   } else if (relPath.length) {
     // it's relative
     // throw away the existing file, and take the new path instead.

lib/zlib.js

@@ -60,7 +60,7 @@ const {
   BROTLI_OPERATION_FINISH
 } = constants;
 
-// translation table for return codes.
+// Translation table for return codes.
 const codes = {
   Z_OK: constants.Z_OK,
   Z_STREAM_END: constants.Z_STREAM_END,
@@ -154,8 +154,8 @@ function zlibBufferSync(engine, buffer) {
 
 function zlibOnError(message, errno, code) {
   var self = this[owner_symbol];
-  // there is no way to cleanly recover.
+  // There is no way to cleanly recover.
-  // continuing only obscures problems.
+  // Continuing only obscures problems.
   _close(self);
   self._hadError = true;
 

test/async-hooks/test-graph.signal.js

@@ -23,10 +23,10 @@ function onsigusr2() {
   count++;
 
   if (count === 1) {
-    // trigger same signal handler again
+    // Trigger same signal handler again
     exec(`kill -USR2 ${process.pid}`);
   } else {
-    // install another signal handler
+    // Install another signal handler
     process.removeAllListeners('SIGUSR2');
     process.on('SIGUSR2', common.mustCall(onsigusr2Again));
 

test/async-hooks/test-promise.promise-before-init-hooks.js

@@ -9,7 +9,7 @@ const p = new Promise(common.mustCall(function executor(resolve) {
   resolve(5);
 }));
 
-// init hooks after promise was created
+// Init hooks after promise was created
 const hooks = initHooks({ allowNoInit: true });
 hooks.enable();
 

test/async-hooks/test-signalwrap.js

@@ -42,7 +42,7 @@ function onsigusr2() {
       signal1, { init: 1, before: 1 },
       ' signal1: when first SIGUSR2 handler is called for the first time');
 
-    // trigger same signal handler again
+    // Trigger same signal handler again
     exec(`kill -USR2 ${process.pid}`);
   } else {
     // second invocation
@@ -50,7 +50,7 @@ function onsigusr2() {
       signal1, { init: 1, before: 2, after: 1 },
       'signal1: when first SIGUSR2 handler is called for the second time');
 
-    // install another signal handler
+    // Install another signal handler
     process.removeAllListeners('SIGUSR2');
     process.on('SIGUSR2', common.mustCall(onsigusr2Again));
 

test/async-hooks/test-tcpwrap.js

@@ -79,7 +79,7 @@ function ontcpConnection(serverConnection) {
     return;
   }
 
-  // only focusing on TCPCONNECTWRAP here
+  // Only focusing on TCPCONNECTWRAP here
   const tcpconnects = hooks.activitiesOfTypes('TCPCONNECTWRAP');
   assert.strictEqual(tcpconnects.length, 1);
   tcpconnect = tcpconnects[0];

test/common/index.js

@@ -811,7 +811,7 @@ module.exports = {
 
     const opensslCmd = spawnSync(opensslCli, ['version']);
     if (opensslCmd.status !== 0 || opensslCmd.error !== undefined) {
-      // openssl command cannot be executed
+      // OpenSSL command cannot be executed
       opensslCli = false;
     }
     return opensslCli;

test/es-module/test-esm-preserve-symlinks-main.js

@@ -50,7 +50,7 @@ function doTest(flags, done) {
   });
 }
 
-// first test the commonjs module loader
+// First test the commonjs module loader
 doTest([], () => {
   // now test the new loader
   doTest(['--experimental-modules'], () => {});

test/internet/test-dgram-broadcast-multi-process.js

@@ -167,7 +167,7 @@ if (process.argv[2] !== 'child') {
     reuseAddr: true
   });
 
-  // bind the address explicitly for sending
+  // Bind the address explicitly for sending
   // INADDR_BROADCAST to only one interface
   sendSocket.bind(common.PORT, bindAddress);
   sendSocket.on('listening', function() {

test/js-native-api/test_function/test.js

@@ -4,7 +4,7 @@
 const common = require('../../common');
 const assert = require('assert');
 
-// testing api calls for function
+// Testing api calls for function
 const test_function = require(`./build/${common.buildType}/test_function`);
 
 function func1() {

test/js-native-api/test_general/test.js

@@ -32,8 +32,7 @@ assert.strictEqual(test_general.testGetPrototype(extendedObject),
 assert.notStrictEqual(test_general.testGetPrototype(baseObject),
                       test_general.testGetPrototype(extendedObject));
 
-// test version management functions
+// Test version management functions. The expected version is currently 4.
-// expected version is currently 4
 assert.strictEqual(test_general.testGetVersion(), 4);
 
 [
@@ -91,7 +90,7 @@ assert.strictEqual(finalizeWasCalled, false,
                    ' test_general.finalizeWasCalled() ' +
                    `returned ${finalizeWasCalled}`);
 
-// test napi_adjust_external_memory
+// Test napi_adjust_external_memory
 const adjustedValue = test_general.testAdjustExternalMemory();
 assert.strictEqual(typeof adjustedValue, 'number');
 assert(adjustedValue > 0);

test/js-native-api/test_handle_scope/test.js

@@ -2,7 +2,7 @@
 const common = require('../../common');
 const assert = require('assert');
 
-// testing handle scope api calls
+// Testing handle scope api calls
 const testHandleScope =
     require(`./build/${common.buildType}/test_handle_scope`);
 

test/js-native-api/test_properties/test.js

@@ -33,7 +33,7 @@ assert.ok(!propertyNames.includes('readwriteAccessor2'));
 assert.ok(!propertyNames.includes('readonlyAccessor1'));
 assert.ok(!propertyNames.includes('readonlyAccessor2'));
 
-// validate property created with symbol
+// Validate property created with symbol
 const start = 'Symbol('.length;
 const end = start + 'NameKeySymbol'.length;
 const symbolDescription =

test/known_issues/test-dgram-bind-shared-ports-after-port-0.js

@@ -29,7 +29,7 @@ if (cluster.isMaster) {
     const worker2 = cluster.fork({ PRT1: msg.port1 });
     worker2.on('message', () => process.exit(0));
     worker2.on('exit', (code, signal) => {
-      // this is the droid we are looking for
+      // This is the droid we are looking for
       assert.strictEqual(code, 0);
       assert.strictEqual(signal, null);
     });

test/known_issues/test-inspector-cluster-port-clash.js

@@ -29,7 +29,7 @@ function serialFork() {
   return new Promise((res) => {
     const worker = cluster.fork();
     worker.on('error', (err) => assert.fail(err));
-    // No common.mustCall since 1 out of 3 should fail
+    // No common.mustCall since 1 out of 3 should fail.
     worker.on('online', () => {
       worker.on('message', common.mustCall((message) => {
         ports.push(message.debugPort);
@@ -50,10 +50,10 @@ function serialFork() {
 if (cluster.isMaster) {
   cluster.on('online', common.mustCall((worker) => worker.send('dbgport'), 2));
 
-  // Block one of the ports with a listening socket
+  // Block one of the ports with a listening socket.
   const server = net.createServer();
   server.listen(clashPort, common.localhostIPv4, common.mustCall(() => {
-    // try to fork 3 workers No.2 should fail
+    // Try to fork 3 workers. No.2 should fail.
     Promise.all([serialFork(), serialFork(), serialFork()])
       .then(common.mustNotCall())
       .catch((err) => console.error(err));

test/message/throw_in_line_with_tabs.js

@@ -26,7 +26,7 @@ require('../common');
 console.error('before');
 
 (function() {
-	// these lines should contain tab!
+	// These lines should contain tab!
 	// eslint-disable-next-line no-throw-literal
 	throw ({ foo: 'bar' });
 })();

test/message/v8_warning.js

@@ -9,7 +9,7 @@ function AsmModule() {
     a = a | 0;
     b = b | 0;
 
-    // should be `return (a + b) | 0;`
+    // Should be `return (a + b) | 0;`
     return a + b;
   }
 

test/parallel/test-assert-deep.js

@@ -503,7 +503,7 @@ assertNotDeepOrStrict(
 
   m2.set(2, 'hi'); // different order
   m2.set(1, obj);
-  m2.set(3, [1, 2, 3]); // deep equal, but not reference equal.
+  m2.set(3, [1, 2, 3]); // Deep equal, but not reference equal.
 
   assertDeepAndStrictEqual(m1, m2);
 }

test/parallel/test-async-wrap-tlssocket-asyncreset.js

@@ -52,7 +52,7 @@ server.listen(
               assert.strictEqual(res.statusCode, 200);
               res2.on('error', (err) => assert.fail(err));
               res2.socket.on('error', (err) => assert.fail(err));
-              // this should be the end of the test
+              // This should be the end of the test
               res2.destroy();
               server.close();
             })

test/parallel/test-buffer-alloc.js

@@ -54,10 +54,10 @@ assert.strictEqual(d.length, 0);
 // Test invalid encoding for Buffer.toString
 assert.throws(() => b.toString('invalid'),
               /Unknown encoding: invalid/);
-// invalid encoding for Buffer.write
+// Invalid encoding for Buffer.write
 assert.throws(() => b.write('test string', 0, 5, 'invalid'),
               /Unknown encoding: invalid/);
-// unsupported arguments for Buffer.write
+// Unsupported arguments for Buffer.write
 assert.throws(() => b.write('test', 'utf8', 0),
               /is no longer supported/);
 
@@ -87,13 +87,13 @@ const outOfRangeError = {
 // Try to write a 0-length string beyond the end of b
 common.expectsError(() => b.write('', 2048), outOfBoundsError);
 
-// throw when writing to negative offset
+// Throw when writing to negative offset
 common.expectsError(() => b.write('a', -1), outOfBoundsError);
 
 // Throw when writing past bounds from the pool
 common.expectsError(() => b.write('a', 2048), outOfBoundsError);
 
-// throw when writing to negative offset
+// Throw when writing to negative offset
 common.expectsError(() => b.write('a', -1), outOfBoundsError);
 
 // Try to copy 0 bytes worth of data into an empty buffer
@@ -192,7 +192,7 @@ Buffer.alloc(1).write('', 1, 0);
 }
 
 {
-  // also from a non-pooled instance
+  // Also from a non-pooled instance
   const b = Buffer.allocUnsafeSlow(5);
   const c = b.slice(0, 4);
   const d = c.slice(0, 2);
@@ -390,7 +390,7 @@ assert.strictEqual(Buffer.from('KioqKioqKioqKioqKioqKioqKio=',
                                'base64').toString(),
                    '*'.repeat(20));
 
-// no padding, not a multiple of 4
+// No padding, not a multiple of 4
 assert.strictEqual(Buffer.from('Kg', 'base64').toString(), '*');
 assert.strictEqual(Buffer.from('Kio', 'base64').toString(), '*'.repeat(2));
 assert.strictEqual(Buffer.from('KioqKg', 'base64').toString(), '*'.repeat(4));
@@ -713,7 +713,7 @@ assert.strictEqual(x.inspect(), '<Buffer 81 a3 66 6f 6f a3 62 61 72>');
 }
 
 {
-  // test offset returns are correct
+  // Test offset returns are correct
   const b = Buffer.allocUnsafe(16);
   assert.strictEqual(b.writeUInt32LE(0, 0), 4);
   assert.strictEqual(b.writeUInt16LE(0, 4), 6);
@@ -818,7 +818,7 @@ common.expectsError(
   outOfRangeError
 );
 
-// test for common write(U)IntLE/BE
+// Test for common write(U)IntLE/BE
 {
   let buf = Buffer.allocUnsafe(3);
   buf.writeUIntLE(0x123456, 0, 3);

test/parallel/test-buffer-bytelength.js

@@ -65,7 +65,7 @@ assert.strictEqual(Buffer.byteLength(float64), 64);
 const dv = new DataView(new ArrayBuffer(2));
 assert.strictEqual(Buffer.byteLength(dv), 2);
 
-// special case: zero length string
+// Special case: zero length string
 assert.strictEqual(Buffer.byteLength('', 'ascii'), 0);
 assert.strictEqual(Buffer.byteLength('', 'HeX'), 0);
 

test/parallel/test-buffer-copy.js

@@ -70,7 +70,7 @@ let cntr = 0;
 }
 
 {
-  // copy starting near end of b to c
+  // Copy starting near end of b to c
   b.fill(++cntr);
   c.fill(++cntr);
   const copied = b.copy(c, 0, b.length - Math.floor(c.length / 2));
@@ -113,7 +113,7 @@ bb.fill('hello crazy world');
 // Try to copy from before the beginning of b. Should not throw.
 b.copy(c, 0, 100, 10);
 
-// copy throws at negative sourceStart
+// Copy throws at negative sourceStart
 common.expectsError(
   () => Buffer.allocUnsafe(5).copy(Buffer.allocUnsafe(5), 0, -1),
   errorProperty);

test/parallel/test-buffer-indexof.js

@@ -78,7 +78,7 @@ assert.strictEqual(b.indexOf(Buffer.from('f'), 6), -1);
 
 assert.strictEqual(Buffer.from('ff').indexOf(Buffer.from('f'), 1, 'ucs2'), -1);
 
-// test invalid and uppercase encoding
+// Test invalid and uppercase encoding
 assert.strictEqual(b.indexOf('b', 'utf8'), 1);
 assert.strictEqual(b.indexOf('b', 'UTF8'), 1);
 assert.strictEqual(b.indexOf('62', 'HEX'), 1);

test/parallel/test-buffer-iterator.js

@@ -16,7 +16,7 @@ for (b of buffer)
 assert.deepStrictEqual(arr, [1, 2, 3, 4, 5]);
 
 
-// buffer iterators should be iterable
+// Buffer iterators should be iterable
 
 arr = [];
 

test/parallel/test-buffer-read.js

@@ -2,7 +2,7 @@
 const common = require('../common');
 const assert = require('assert');
 
-// testing basic buffer read functions
+// Testing basic buffer read functions
 const buf = Buffer.from([0xa4, 0xfd, 0x48, 0xea, 0xcf, 0xff, 0xd9, 0x01, 0xde]);
 
 function read(buff, funx, args, expected) {

test/parallel/test-buffer-slow.js

@@ -43,7 +43,7 @@ try {
 assert.strictEqual(SlowBuffer('6').length, 6);
 assert.strictEqual(SlowBuffer(true).length, 1);
 
-// should throw with invalid length
+// Should throw with invalid length
 const bufferMaxSizeMsg = common.expectsError({
   code: 'ERR_INVALID_OPT_VALUE',
   type: RangeError,

test/parallel/test-child-process-constructor.js

@@ -85,7 +85,7 @@ child.spawn({
 assert.strictEqual(child.hasOwnProperty('pid'), true);
 assert(Number.isInteger(child.pid));
 
-// try killing with invalid signal
+// Try killing with invalid signal
 common.expectsError(
   () => { child.kill('foo'); },
   { code: 'ERR_UNKNOWN_SIGNAL', type: TypeError }

test/parallel/test-child-process-disconnect.js

@@ -57,7 +57,7 @@ if (process.argv[2] === 'child') {
     socket.write('ready');
   });
 
-  // when the server is ready tell parent
+  // When the server is ready tell parent
   server.on('listening', function() {
     process.send({ msg: 'ready', port: server.address().port });
   });

test/parallel/test-child-process-double-pipe.js

@@ -65,7 +65,7 @@ grep.stdin.on('drain', function(data) {
   echo.stdout.resume();
 });
 
-// propagate end from echo to grep
+// Propagate end from echo to grep
 echo.stdout.on('end', function(code) {
   grep.stdin.end();
 });
@@ -95,7 +95,7 @@ sed.stdin.on('drain', function(data) {
   grep.stdout.resume();
 });
 
-// propagate end from grep to sed
+// Propagate end from grep to sed
 grep.stdout.on('end', function(code) {
   console.error('grep stdout end');
   sed.stdin.end();

test/parallel/test-child-process-fork-ref.js

@@ -27,7 +27,7 @@ const fork = require('child_process').fork;
 if (process.argv[2] === 'child') {
   process.send('1');
 
-  // check that child don't instantly die
+  // Check that child don't instantly die
   setTimeout(function() {
     process.send('2');
   }, 200);

test/parallel/test-child-process-stdio-big-write-end.js

@@ -56,14 +56,14 @@ function parent() {
     sent += bufsize;
   } while (child.stdin.write(buf));
 
-  // then write a bunch more times.
+  // Then write a bunch more times.
   for (let i = 0; i < 100; i++) {
     const buf = Buffer.alloc(bufsize, '.');
     sent += bufsize;
     child.stdin.write(buf);
   }
 
-  // now end, before it's all flushed.
+  // Now end, before it's all flushed.
   child.stdin.end();
 
   // now we wait...

test/parallel/test-child-process-stdio-inherit.js

@@ -45,7 +45,7 @@ function grandparent() {
   child.on('close', function(code, signal) {
     assert.strictEqual(code, 0);
     assert.strictEqual(signal, null);
-    // cat on windows adds a \r\n at the end.
+    // 'cat' on windows adds a \r\n at the end.
     assert.strictEqual(output.trim(), input.trim());
   });
 }

test/parallel/test-child-process-validate-stdio.js

@@ -11,7 +11,7 @@ const expectedError =
 // Should throw if string and not ignore, pipe, or inherit
 assert.throws(() => _validateStdio('foo'), expectedError);
 
-// should throw if not a string or array
+// Should throw if not a string or array
 assert.throws(() => _validateStdio(600), expectedError);
 
 // Should populate stdio with undefined if len < 3

test/parallel/test-cli-syntax-piped-bad.js

@@ -25,7 +25,7 @@ syntaxArgs.forEach(function(args) {
   // stderr should include '[stdin]' as the filename
   assert(c.stderr.startsWith('[stdin]'), `${c.stderr} starts with ${stdin}`);
 
-  // no stdout or stderr should be produced
+  // No stdout or stderr should be produced
   assert.strictEqual(c.stdout, '');
 
   // stderr should have a syntax error message

test/parallel/test-cli-syntax-piped-good.js

@@ -18,7 +18,7 @@ syntaxArgs.forEach(function(args) {
   const stdin = 'throw new Error("should not get run");';
   const c = spawnSync(node, args, { encoding: 'utf8', input: stdin });
 
-  // no stdout or stderr should be produced
+  // No stdout or stderr should be produced
   assert.strictEqual(c.stdout, '');
   assert.strictEqual(c.stderr, '');
 

test/parallel/test-cluster-disconnect.js

@@ -92,7 +92,7 @@ if (cluster.isWorker) {
       testCluster(common.mustCall(() => {
         // 3. disconnect cluster
         cluster.disconnect(common.mustCall(() => {
-          // run test again to confirm cleanup
+          // Run test again to confirm cleanup
           if (again) {
             test();
           }

test/parallel/test-cluster-eaccess.js

@@ -41,7 +41,7 @@ if (cluster.isMaster && process.argv.length !== 3) {
   // Makes sure master is able to fork the worker
   cluster.on('fork', common.mustCall());
 
-  // makes sure the worker is ready
+  // Makes sure the worker is ready
   worker.on('online', common.mustCall());
 
   worker.on('message', common.mustCall(function(err) {
@@ -71,7 +71,7 @@ if (cluster.isMaster && process.argv.length !== 3) {
     });
   }));
 } else if (process.argv.length === 3) {
-  // child process (of cluster.worker)
+  // Child process (of cluster.worker)
   const PIPE_NAME = process.argv[2];
 
   const server = net.createServer().listen(PIPE_NAME, common.mustCall(() => {

test/parallel/test-cluster-listening-port.js

@@ -8,9 +8,9 @@ if (cluster.isMaster) {
   cluster.fork();
   cluster.on('listening', common.mustCall(function(worker, address) {
     const port = address.port;
-    // ensure that the port is not 0 or null
+    // Ensure that the port is not 0 or null
     assert(port);
-    // ensure that the port is numerical
+    // Ensure that the port is numerical
     assert.strictEqual(typeof port, 'number');
     worker.kill();
   }));

test/parallel/test-cluster-net-listen.js

@@ -26,7 +26,7 @@ const cluster = require('cluster');
 const net = require('net');
 
 if (cluster.isMaster) {
-  // ensure that the worker exits peacefully
+  // Ensure that the worker exits peacefully
   cluster.fork().on('exit', common.mustCall(function(statusCode) {
     assert.strictEqual(statusCode, 0);
   }));

test/parallel/test-common.js

@@ -26,7 +26,7 @@ const fixtures = require('../common/fixtures');
 const assert = require('assert');
 const { execFile } = require('child_process');
 
-// test for leaked global detection
+// Test for leaked global detection
 {
   const p = fixtures.path('leakedGlobal.js');
   execFile(process.execPath, [p], common.mustCall((err, stdout, stderr) => {

test/parallel/test-console.js

@@ -93,35 +93,35 @@ hijackStderr(function(data) {
   errStrings.push(data);
 });
 
-// test console.log() goes to stdout
+// Test console.log() goes to stdout
 console.log('foo');
 console.log('foo', 'bar');
 console.log('%s %s', 'foo', 'bar', 'hop');
 console.log({ slashes: '\\\\' });
 console.log(custom_inspect);
 
-// test console.debug() goes to stdout
+// Test console.debug() goes to stdout
 console.debug('foo');
 console.debug('foo', 'bar');
 console.debug('%s %s', 'foo', 'bar', 'hop');
 console.debug({ slashes: '\\\\' });
 console.debug(custom_inspect);
 
-// test console.info() goes to stdout
+// Test console.info() goes to stdout
 console.info('foo');
 console.info('foo', 'bar');
 console.info('%s %s', 'foo', 'bar', 'hop');
 console.info({ slashes: '\\\\' });
 console.info(custom_inspect);
 
-// test console.error() goes to stderr
+// Test console.error() goes to stderr
 console.error('foo');
 console.error('foo', 'bar');
 console.error('%s %s', 'foo', 'bar', 'hop');
 console.error({ slashes: '\\\\' });
 console.error(custom_inspect);
 
-// test console.warn() goes to stderr
+// Test console.warn() goes to stderr
 console.warn('foo');
 console.warn('foo', 'bar');
 console.warn('%s %s', 'foo', 'bar', 'hop');

test/parallel/test-crypto-binary-default.js

@@ -480,8 +480,8 @@ function testCipher1(key) {
 
 
 function testCipher2(key) {
-  // encryption and decryption with Base64
+  // Encryption and decryption with Base64.
-  // reported in https://github.com/joyent/node/issues/738
+  // Reported in https://github.com/joyent/node/issues/738
   const plaintext =
       '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' +
       'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' +

test/parallel/test-crypto-cipher-decipher.js

@@ -53,16 +53,16 @@ function testCipher1(key) {
 
 
 function testCipher2(key) {
-  // encryption and decryption with Base64
+  // Encryption and decryption with Base64.
-  // reported in https://github.com/joyent/node/issues/738
+  // Reported in https://github.com/joyent/node/issues/738
   const plaintext =
       '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' +
       'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' +
       'jAfaFg**';
   const cipher = crypto.createCipher('aes256', key);
 
-  // Encrypt plaintext which is in utf8 format
+  // Encrypt plaintext which is in utf8 format to a ciphertext which will be in
-  // to a ciphertext which will be in Base64
+  // Base64.
   let ciph = cipher.update(plaintext, 'utf8', 'base64');
   ciph += cipher.final('base64');
 

test/parallel/test-crypto-from-binary.js

@@ -36,7 +36,7 @@ const EXTERN_APEX = 0xFBEE9;
 // Manually controlled string for checking binary output
 let ucs2_control = 'a\u0000';
 
-// grow the strings to proper length
+// Grow the strings to proper length
 while (ucs2_control.length <= EXTERN_APEX) {
   ucs2_control = ucs2_control.repeat(2);
 }

test/parallel/test-crypto-keygen.js

@@ -639,7 +639,7 @@ const sec1EncExp = (cipher) => getRegExpForPEM('EC PRIVATE KEY', cipher);
     message: 'Unknown cipher'
   });
 
-  // cipher, but no valid passphrase.
+  // Cipher, but no valid passphrase.
   for (const passphrase of [undefined, null, 5, false, true]) {
     common.expectsError(() => generateKeyPairSync('rsa', {
       modulusLength: 4096,

test/parallel/test-domain-multi.js

@@ -27,7 +27,7 @@ const domain = require('domain');
 const http = require('http');
 
 const a = domain.create();
-a.enter(); // this will be our "root" domain
+a.enter(); // This will be our "root" domain
 
 a.on('error', common.mustNotCall());
 
@@ -62,11 +62,11 @@ const server = http.createServer((req, res) => {
   const c = domain.create();
   const req = http.get({ host: 'localhost', port: server.address().port });
 
-  // add the request to the C domain
+  // Add the request to the C domain
   c.add(req);
 
   req.on('response', (res) => {
-    // add the response object to the C domain
+    // Add the response object to the C domain
     c.add(res);
     res.pipe(process.stdout);
   });

test/parallel/test-event-emitter-add-listeners.js

@@ -60,7 +60,7 @@ const EventEmitter = require('events');
   ee.emit('hello', 'a', 'b');
 }
 
-// just make sure that this doesn't throw:
+// Just make sure that this doesn't throw:
 {
   const f = new EventEmitter();
 

test/parallel/test-file-write-stream2.js

@@ -62,7 +62,7 @@ function removeTestFile() {
 
 tmpdir.refresh();
 
-// drain at 0, return false at 10.
+// Drain at 0, return false at 10.
 const file = fs.createWriteStream(filepath, {
   highWaterMark: 11
 });

test/parallel/test-fs-append-file-sync.js

@@ -39,7 +39,7 @@ const data = '南越国是前203年至前111年存在于岭南地区的一个国
 const tmpdir = require('../common/tmpdir');
 tmpdir.refresh();
 
-// Test that empty file will be created and have content added
+// Test that empty file will be created and have content added.
 const filename = join(tmpdir.path, 'append-sync.txt');
 
 fs.appendFileSync(filename, data);
@@ -48,7 +48,7 @@ const fileData = fs.readFileSync(filename);
 
 assert.strictEqual(Buffer.byteLength(data), fileData.length);
 
-// Test that appends data to a non empty file
+// Test that appends data to a non empty file.
 const filename2 = join(tmpdir.path, 'append-sync2.txt');
 fs.writeFileSync(filename2, currentFileData);
 
@@ -59,7 +59,7 @@ const fileData2 = fs.readFileSync(filename2);
 assert.strictEqual(Buffer.byteLength(data) + currentFileData.length,
                    fileData2.length);
 
-// Test that appendFileSync accepts buffers
+// Test that appendFileSync accepts buffers.
 const filename3 = join(tmpdir.path, 'append-sync3.txt');
 fs.writeFileSync(filename3, currentFileData);
 
@@ -70,13 +70,13 @@ const fileData3 = fs.readFileSync(filename3);
 
 assert.strictEqual(buf.length + currentFileData.length, fileData3.length);
 
-// test that appendFile accepts numbers.
+// Test that appendFile accepts numbers.
 const filename4 = join(tmpdir.path, 'append-sync4.txt');
 fs.writeFileSync(filename4, currentFileData, { mode: m });
 
 fs.appendFileSync(filename4, num, { mode: m });
 
-// windows permissions aren't unix
+// Windows permissions aren't Unix.
 if (!common.isWindows) {
   const st = fs.statSync(filename4);
   assert.strictEqual(st.mode & 0o700, m);
@@ -87,7 +87,7 @@ const fileData4 = fs.readFileSync(filename4);
 assert.strictEqual(Buffer.byteLength(String(num)) + currentFileData.length,
                    fileData4.length);
 
-// Test that appendFile accepts file descriptors
+// Test that appendFile accepts file descriptors.
 const filename5 = join(tmpdir.path, 'append-sync5.txt');
 fs.writeFileSync(filename5, currentFileData);
 
@@ -100,7 +100,7 @@ const fileData5 = fs.readFileSync(filename5);
 assert.strictEqual(Buffer.byteLength(data) + currentFileData.length,
                    fileData5.length);
 
-// Exit logic for cleanup
+// Exit logic for cleanup.
 
 process.on('exit', function() {
   fs.unlinkSync(filename);

test/parallel/test-fs-append-file.js

@@ -42,7 +42,7 @@ tmpdir.refresh();
 
 const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
 
-// Test that empty file will be created and have content added (callback API)
+// Test that empty file will be created and have content added (callback API).
 {
   const filename = join(tmpdir.path, 'append.txt');
 
@@ -56,7 +56,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   }));
 }
 
-// Test that empty file will be created and have content added (promise API)
+// Test that empty file will be created and have content added (promise API).
 {
   const filename = join(tmpdir.path, 'append-promise.txt');
 
@@ -68,7 +68,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
     .catch(throwNextTick);
 }
 
-// Test that appends data to a non-empty file (callback API)
+// Test that appends data to a non-empty file (callback API).
 {
   const filename = join(tmpdir.path, 'append-non-empty.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -84,7 +84,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   }));
 }
 
-// Test that appends data to a non-empty file (promise API)
+// Test that appends data to a non-empty file (promise API).
 {
   const filename = join(tmpdir.path, 'append-non-empty-promise.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -98,7 +98,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
     .catch(throwNextTick);
 }
 
-// Test that appendFile accepts buffers (callback API)
+// Test that appendFile accepts buffers (callback API).
 {
   const filename = join(tmpdir.path, 'append-buffer.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -115,7 +115,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   }));
 }
 
-// Test that appendFile accepts buffers (promises API)
+// Test that appendFile accepts buffers (promises API).
 {
   const filename = join(tmpdir.path, 'append-buffer-promises.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -130,7 +130,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
     .catch(throwNextTick);
 }
 
-// Test that appendFile accepts numbers (callback API)
+// Test that appendFile accepts numbers (callback API).
 {
   const filename = join(tmpdir.path, 'append-numbers.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -139,7 +139,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   fs.appendFile(filename, n, { mode: m }, common.mustCall((e) => {
     assert.ifError(e);
 
-    // windows permissions aren't unix
+    // Windows permissions aren't Unix.
     if (!common.isWindows) {
       const st = fs.statSync(filename);
       assert.strictEqual(st.mode & 0o700, m);
@@ -153,7 +153,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   }));
 }
 
-// Test that appendFile accepts numbers (promises API)
+// Test that appendFile accepts numbers (promises API).
 {
   const filename = join(tmpdir.path, 'append-numbers-promises.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -161,7 +161,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   const m = 0o600;
   fs.promises.appendFile(filename, n, { mode: m })
     .then(common.mustCall(() => {
-      // windows permissions aren't unix
+      // Windows permissions aren't Unix.
       if (!common.isWindows) {
         const st = fs.statSync(filename);
         assert.strictEqual(st.mode & 0o700, m);
@@ -176,7 +176,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
     .catch(throwNextTick);
 }
 
-// Test that appendFile accepts file descriptors (callback API)
+// Test that appendFile accepts file descriptors (callback API).
 {
   const filename = join(tmpdir.path, 'append-descriptors.txt');
   fs.writeFileSync(filename, currentFileData);
@@ -200,7 +200,7 @@ const throwNextTick = (e) => { process.nextTick(() => { throw e; }); };
   }));
 }
 
-// Test that appendFile accepts file descriptors (promises API)
+// Test that appendFile accepts file descriptors (promises API).
 {
   const filename = join(tmpdir.path, 'append-descriptors-promises.txt');
   fs.writeFileSync(filename, currentFileData);

test/parallel/test-fs-error-messages.js

@@ -321,7 +321,7 @@ function re(literals, ...values) {
         `ENOTEMPTY: directory not empty, rename '${existingDir}' -> ` +
         `'${existingDir2}'`);
       assert.strictEqual(err.errno, UV_ENOTEMPTY);
-    } else if (err.code === 'EXDEV') {  // not on the same mounted filesystem
+    } else if (err.code === 'EXDEV') {  // Not on the same mounted filesystem
       assert.strictEqual(
         err.message,
         `EXDEV: cross-device link not permitted, rename '${existingDir}' -> ` +

test/parallel/test-fs-link.js

@@ -7,7 +7,7 @@ const fs = require('fs');
 const tmpdir = require('../common/tmpdir');
 tmpdir.refresh();
 
-// test creating and reading hard link
+// Test creating and reading hard link
 const srcPath = path.join(tmpdir.path, 'hardlink-target.txt');
 const dstPath = path.join(tmpdir.path, 'link1.js');
 fs.writeFileSync(srcPath, 'hello world');

test/parallel/test-fs-mkdir.js

@@ -132,7 +132,7 @@ function nextdir() {
   }
 }
 
-// mkdirp when folder does not yet exist.
+// `mkdirp` when folder does not yet exist.
 {
   const pathname = path.join(tmpdir.path, nextdir(), nextdir());
 

test/parallel/test-fs-open.js

@@ -27,7 +27,7 @@ const fs = require('fs');
 let caughtException = false;
 
 try {
-  // should throw ENOENT, not EBADF
+  // Should throw ENOENT, not EBADF
   // see https://github.com/joyent/node/pull/1228
   fs.openSync('/path/to/file/that/does/not/exist', 'r');
 } catch (e) {

test/parallel/test-fs-promises-file-handle-chmod.js

@@ -17,7 +17,7 @@ tmpdir.refresh();
 async function validateFilePermission() {
   const filePath = path.resolve(tmpDir, 'tmp-chmod.txt');
   const fileHandle = await open(filePath, 'w+', 0o444);
-  // file created with r--r--r-- 444
+  // File created with r--r--r-- 444
   const statsBeforeMod = fs.statSync(filePath);
   assert.deepStrictEqual(statsBeforeMod.mode & 0o444, 0o444);
 
@@ -34,7 +34,7 @@ async function validateFilePermission() {
     expectedAccess = newPermissions;
   }
 
-  // change the permissions to rwxr--r-x
+  // Change the permissions to rwxr--r-x
   await fileHandle.chmod(newPermissions);
   const statsAfterMod = fs.statSync(filePath);
   assert.deepStrictEqual(statsAfterMod.mode & expectedAccess, expectedAccess);

test/parallel/test-fs-promises.js

@@ -119,7 +119,7 @@ async function getHandle(dest) {
       await unlink(dest);
     }
 
-    // bytes written to file match buffer
+    // Bytes written to file match buffer
     {
       const handle = await getHandle(dest);
       const buf = Buffer.from('hello fsPromises');
@@ -130,7 +130,7 @@ async function getHandle(dest) {
       assert.deepStrictEqual(ret.buffer, buf);
     }
 
-    // truncate file to specified length
+    // Truncate file to specified length
     {
       const handle = await getHandle(dest);
       const buf = Buffer.from('hello FileHandle');
@@ -224,7 +224,7 @@ async function getHandle(dest) {
 
         const newMode = 0o666;
         if (common.isOSX) {
-          // lchmod is only available on macOS
+          // `lchmod` is only available on macOS.
           await lchmod(newLink, newMode);
           stats = await lstat(newLink);
           assert.strictEqual(stats.mode & 0o777, newMode);
@@ -287,7 +287,7 @@ async function getHandle(dest) {
       assert(stats.isDirectory());
     }
 
-    // mkdirp when folder does not yet exist.
+    // `mkdirp` when folder does not yet exist.
     {
       const dir = path.join(tmpDir, nextdir(), nextdir());
       await mkdir(dir, { recursive: true });
@@ -344,7 +344,7 @@ async function getHandle(dest) {
       });
     }
 
-    // mkdtemp with invalid numeric prefix
+    // `mkdtemp` with invalid numeric prefix
     {
       await mkdtemp(path.resolve(tmpDir, 'FOO'));
       assert.rejects(