benchmark,doc,lib,test: capitalize comments

PR-URL: #26483 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
nodejs · refack · Feb 11, 2019 · Mar 2, 2019 · Mar 2, 2019 · Mar 1, 2019
commit 2b57c6555f0a6bbb25b2c5a4174ccbb73b26da38
diff --git a/benchmark/_cli.js b/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

diff --git a/benchmark/net/net-c2s-cork.js b/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() {};

diff --git a/benchmark/net/net-c2s.js b/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() {};

diff --git a/benchmark/net/net-pipe.js b/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() {};

diff --git a/benchmark/net/net-s2c.js b/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() {};

diff --git a/benchmark/net/net-wrap-js-stream-passthrough.js b/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() {};

diff --git a/benchmark/net/tcp-raw-s2c.js b/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'],

diff --git a/benchmark/run.js b/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

diff --git a/benchmark/timers/immediate.js b/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;

diff --git a/doc/api/cluster.md b/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);
 }

diff --git a/doc/api/dgram.md b/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])

diff --git a/doc/api/domain.md b/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...

diff --git a/doc/api/errors.md b/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!');
   });

diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1908,7 +1908,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'));
@@ -3899,7 +3899,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();
     }
   }
@@ -3926,7 +3926,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();
     }
   }

diff --git a/doc/api/http.md b/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' +
@@ -1307,7 +1307,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');
@@ -1500,7 +1500,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');
@@ -1912,7 +1912,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;
   }

diff --git a/doc/api/http2.md b/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');

diff --git a/doc/api/inspector.md b/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));
       }

diff --git a/doc/api/modules.md b/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');
 ```
 

diff --git a/doc/api/net.md b/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());
 });

diff --git a/doc/api/perf_hooks.md b/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 });
 

diff --git a/doc/api/process.md b/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);
 ```
 

diff --git a/doc/api/readline.md b/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];
 }
 ```

diff --git a/doc/api/stream.md b/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
-        // don't pass the callback, because we're not done yet.
+        // See if we should continue, or wait.
+        // 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);
 ```

diff --git a/lib/_http_agent.js b/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) {