benchmark,doc,lib: capitalize more comments

PR-URL: #26849
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>

Author: BridgeAR

benchmark/_cli.js

@@ -16,7 +16,7 @@ function CLI(usage, settings) {
   if (!(this instanceof CLI)) return new CLI(usage, settings);
 
   if (process.argv.length < 3) {
-    this.abort(usage); // abort will exit the process
+    this.abort(usage); // Abort will exit the process
   }
 
   this.usage = usage;

benchmark/common.js

@@ -202,7 +202,7 @@ Benchmark.prototype.end = function(operations) {
   if (elapsed[0] === 0 && elapsed[1] === 0) {
     if (!process.env.NODEJS_BENCHMARK_ZERO_ALLOWED)
       throw new Error('insufficient clock precision for short benchmark');
-    // avoid dividing by zero
+    // Avoid dividing by zero
     elapsed[1] = 1;
   }
 

benchmark/crypto/hash-stream-creation.js

@@ -1,4 +1,4 @@
-// throughput benchmark
+// Throughput benchmark
 // creates a single hasher, then pushes a bunch of data through it
 'use strict';
 const common = require('../common.js');

benchmark/crypto/hash-stream-throughput.js

@@ -1,4 +1,4 @@
-// throughput benchmark
+// Throughput benchmark
 // creates a single hasher, then pushes a bunch of data through it
 'use strict';
 const common = require('../common.js');

benchmark/fixtures/simple-http-server.js

@@ -9,7 +9,7 @@ const storedUnicode = Object.create(null);
 
 const useDomains = process.env.NODE_USE_DOMAINS;
 
-// set up one global domain.
+// Set up one global domain.
 if (useDomains) {
   var domain = require('domain');
   const gdom = domain.create();

benchmark/http/cluster.js

@@ -5,7 +5,7 @@ const PORT = common.PORT;
 const cluster = require('cluster');
 if (cluster.isMaster) {
   var bench = common.createBenchmark(main, {
-    // unicode confuses ab on os x.
+    // Unicode confuses ab on os x.
     type: ['bytes', 'buffer'],
     len: [4, 1024, 102400],
     c: [50, 500]

benchmark/http/incoming_headers.js

@@ -3,7 +3,7 @@ const common = require('../common.js');
 const http = require('http');
 
 const bench = common.createBenchmark(main, {
-  // unicode confuses ab on os x.
+  // Unicode confuses ab on os x.
   c: [50, 500],
   n: [0, 5, 20]
 });

benchmark/http/simple.js

@@ -2,7 +2,7 @@
 const common = require('../common.js');
 
 const bench = common.createBenchmark(main, {
-  // unicode confuses ab on os x.
+  // Unicode confuses ab on os x.
   type: ['bytes', 'buffer'],
   len: [4, 1024, 102400],
   chunks: [1, 4],

benchmark/net/net-c2s-cork.js

@@ -33,7 +33,7 @@ function main({ dur, len, type }) {
 
   const writer = new Writer();
 
-  // the actual benchmark.
+  // The actual benchmark.
   const server = net.createServer((socket) => {
     socket.pipe(writer);
   });

benchmark/net/net-c2s.js

@@ -34,7 +34,7 @@ function main({ dur, len, type }) {
   const reader = new Reader();
   const writer = new Writer();
 
-  // the actual benchmark.
+  // The actual benchmark.
   const server = net.createServer((socket) => {
     socket.pipe(writer);
   });

benchmark/net/net-pipe.js

@@ -34,7 +34,7 @@ function main({ dur, len, type }) {
   const reader = new Reader();
   const writer = new Writer();
 
-  // the actual benchmark.
+  // The actual benchmark.
   const server = net.createServer((socket) => {
     socket.pipe(socket);
   });

benchmark/net/net-s2c.js

@@ -33,7 +33,7 @@ function main({ dur, len, type }) {
   const reader = new Reader();
   const writer = new Writer();
 
-  // the actual benchmark.
+  // The actual benchmark.
   const server = net.createServer((socket) => {
     reader.pipe(socket);
   });

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

@@ -38,7 +38,7 @@ function main({ dur, len, type }) {
   const reader = new Reader();
   const writer = new Writer();
 
-  // the actual benchmark.
+  // The actual benchmark.
   const fakeSocket = new JSStreamWrap(new PassThrough());
   bench.start();
   reader.pipe(fakeSocket);

benchmark/url/legacy-vs-whatwg-url-parse.js

@@ -13,7 +13,7 @@ const bench = common.createBenchmark(main, {
 
 function useLegacy(data) {
   const len = data.length;
-  var result = url.parse(data[0]);  // avoid dead code elimination
+  var result = url.parse(data[0]);  // Avoid dead code elimination
   bench.start();
   for (var i = 0; i < len; ++i) {
     result = url.parse(data[i]);
@@ -24,7 +24,7 @@ function useLegacy(data) {
 
 function useWHATWGWithBase(data) {
   const len = data.length;
-  var result = new URL(data[0][0], data[0][1]);  // avoid dead code elimination
+  var result = new URL(data[0][0], data[0][1]);  // Avoid dead code elimination
   bench.start();
   for (var i = 0; i < len; ++i) {
     const item = data[i];
@@ -36,7 +36,7 @@ function useWHATWGWithBase(data) {
 
 function useWHATWGWithoutBase(data) {
   const len = data.length;
-  var result = new URL(data[0]);  // avoid dead code elimination
+  var result = new URL(data[0]);  // Avoid dead code elimination
   bench.start();
   for (var i = 0; i < len; ++i) {
     result = new URL(data[i]);

benchmark/url/url-searchparams-sort.js

@@ -3,7 +3,7 @@ const common = require('../common.js');
 const URLSearchParams = require('url').URLSearchParams;
 
 const inputs = {
-  wpt: 'wpt',  // to work around tests
+  wpt: 'wpt',  // To work around tests
   empty: '',
   sorted: 'a&b&c&d&e&f&g&h&i&j&k&l&m&n&o&p&q&r&s&t&u&v&w&x&y&z',
   almostsorted: 'a&b&c&d&e&f&g&i&h&j&k&l&m&n&o&p&q&r&s&t&u&w&v&x&y&z',

doc/api/cluster.md

@@ -315,7 +315,7 @@ if (cluster.isMaster) {
 } else if (cluster.isWorker) {
   const net = require('net');
   const server = net.createServer((socket) => {
-    // connections never end
+    // Connections never end
   });
 
   server.listen(8000);

doc/api/console.md

@@ -114,12 +114,12 @@ error output. If `stderr` is not provided, `stdout` is used for `stderr`.
 ```js
 const output = fs.createWriteStream('./stdout.log');
 const errorOutput = fs.createWriteStream('./stderr.log');
-// custom simple logger
+// Custom simple logger
 const logger = new Console({ stdout: output, stderr: errorOutput });
 // use it like console
 const count = 5;
 logger.log('count: %d', count);
-// in stdout.log: count 5
+// In stdout.log: count 5
 ```
 
 The global `console` is a special `Console` whose output is sent to

doc/api/domain.md

@@ -135,7 +135,7 @@ if (cluster.isMaster) {
         // But don't keep the process open just for that!
         killtimer.unref();
 
-        // stop taking new requests.
+        // Stop taking new requests.
         server.close();
 
         // Let the master know we're dead. This will trigger a
@@ -316,14 +316,13 @@ const d = domain.create();
 
 function readSomeFile(filename, cb) {
   fs.readFile(filename, 'utf8', d.bind((er, data) => {
-    // If this throws, it will also be passed to the domain
+    // If this throws, it will also be passed to the domain.
     return cb(er, data ? JSON.parse(data) : null);
   }));
 }
 
 d.on('error', (er) => {
-  // an error occurred somewhere.
-  // if we throw it now, it will crash the program
+  // An error occurred somewhere. If we throw it now, it will crash the program
   // with the normal line number and stack message.
 });
 ```
@@ -377,7 +376,7 @@ function readSomeFile(filename, cb) {
     // callback since it is assumed to be the 'Error' argument
     // and thus intercepted by the domain.
 
-    // if this throws, it will also be passed to the domain
+    // If this throws, it will also be passed to the domain
     // so the error-handling logic can be moved to the 'error'
     // event on the domain instead of being repeated throughout
     // the program.
@@ -386,8 +385,7 @@ function readSomeFile(filename, cb) {
 }
 
 d.on('error', (er) => {
-  // an error occurred somewhere.
-  // if we throw it now, it will crash the program
+  // An error occurred somewhere. If we throw it now, it will crash the program
   // with the normal line number and stack message.
 });
 ```

doc/api/errors.md

@@ -407,7 +407,7 @@ program.
 try {
   require('vm').runInThisContext('binary ! isNotOk');
 } catch (err) {
-  // err will be a SyntaxError
+  // 'err' will be a SyntaxError.
 }
 ```
 
@@ -422,7 +422,7 @@ string would be considered a `TypeError`.
 
 ```js
 require('url').parse(() => { });
-// throws TypeError, since it expected a string
+// Throws TypeError, since it expected a string.
 ```
 
 Node.js will generate and throw `TypeError` instances *immediately* as a form

doc/api/events.md

@@ -648,7 +648,7 @@ emitter.on('log', () => console.log('log persistently'));
 // Will return a new Array with a single function bound by `.on()` above
 const newListeners = emitter.rawListeners('log');
 
-// logs "log persistently" twice
+// Logs "log persistently" twice
 newListeners[0]();
 emitter.emit('log');
 ```

doc/api/http.md

@@ -358,7 +358,7 @@ const proxy = http.createServer((req, res) => {
   res.end('okay');
 });
 proxy.on('connect', (req, cltSocket, head) => {
-  // connect to an origin server
+  // Connect to an origin server
   const srvUrl = url.parse(`http://${req.url}`);
   const srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {
     cltSocket.write('HTTP/1.1 200 Connection Established\r\n' +
@@ -370,7 +370,7 @@ proxy.on('connect', (req, cltSocket, head) => {
   });
 });
 
-// now that proxy is running
+// Now that proxy is running
 proxy.listen(1337, '127.0.0.1', () => {
 
   // Make a request to a tunneling proxy
@@ -504,7 +504,7 @@ srv.on('upgrade', (req, socket, head) => {
   socket.pipe(socket); // echo back
 });
 
-// now that server is running
+// Now that server is running
 srv.listen(1337, '127.0.0.1', () => {
 
   // make a request
@@ -626,11 +626,11 @@ request.setHeader('content-type', 'text/html');
 request.setHeader('Content-Length', Buffer.byteLength(body));
 request.setHeader('Cookie', ['type=ninja', 'language=javascript']);
 const contentType = request.getHeader('Content-Type');
-// contentType is 'text/html'
+// 'contentType' is 'text/html'
 const contentLength = request.getHeader('Content-Length');
-// contentLength is of type number
+// 'contentLength' is of type number
 const cookie = request.getHeader('Cookie');
-// cookie is of type string[]
+// 'cookie' is of type string[]
 ```
 
 ### request.maxHeadersCount
@@ -745,7 +745,7 @@ req.once('response', (res) => {
   const ip = req.socket.localAddress;
   const port = req.socket.localPort;
   console.log(`Your IP address is ${ip} and your source port is ${port}.`);
-  // consume response object
+  // Consume response object
 });
 ```
 
@@ -2065,7 +2065,7 @@ req.on('error', (e) => {
   console.error(`problem with request: ${e.message}`);
 });
 
-// write data to request body
+// Write data to request body
 req.write(postData);
 req.end();
 ```

doc/api/http2.md

@@ -2437,7 +2437,7 @@ const client = http2.connect('http://localhost');
 
 client.on('stream', (pushedStream, requestHeaders) => {
   pushedStream.on('push', (responseHeaders) => {
-    // process response headers
+    // Process response headers
   });
   pushedStream.on('data', (chunk) => { /* handle pushed data */ });
 });

doc/api/process.md

@@ -295,8 +295,8 @@ process.on('unhandledRejection', (reason, p) => {
 });
 
 somePromise.then((res) => {
-  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)
-}); // no `.catch()` or `.then()`
+  return reportToUser(JSON.pasre(res)); // Note the typo (`pasre`)
+}); // No `.catch()` or `.then()`
 ```
 
 The following will also trigger the `'unhandledRejection'` event to be

doc/api/querystring.md

@@ -126,7 +126,7 @@ querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' });
 // Returns 'foo=bar&baz=qux&baz=quux&corge='
 
 querystring.stringify({ foo: 'bar', baz: 'qux' }, ';', ':');
-// returns 'foo:bar;baz:qux'
+// Returns 'foo:bar;baz:qux'
 ```
 
 By default, characters requiring percent-encoding within the query string will

doc/api/stream.md

@@ -683,7 +683,7 @@ pass.unpipe(writable);
 // readableFlowing is now false
 
 pass.on('data', (chunk) => { console.log(chunk.toString()); });
-pass.write('ok');  // will not emit 'data'
+pass.write('ok');  // Will not emit 'data'
 pass.resume();     // Must be called to make stream emit 'data'
 ```
 
@@ -1206,7 +1206,7 @@ function parseHeader(stream, callback) {
     while (null !== (chunk = stream.read())) {
       const str = decoder.write(chunk);
       if (str.match(/\n\n/)) {
-        // found the header boundary
+        // Found the header boundary
         const split = str.split(/\n\n/);
         header += split.shift();
         const remaining = split.join('\n\n');
@@ -1219,7 +1219,7 @@ function parseHeader(stream, callback) {
         // Now the body of the message can be read from the stream.
         callback(null, header, stream);
       } else {
-        // still reading the header.
+        // Still reading the header.
         header += str;
       }
     }

doc/api/timers.md

@@ -163,7 +163,7 @@ setImmediatePromise('foobar').then((value) => {
   // This is executed after all I/O callbacks.
 });
 
-// or with async function
+// Or with async function
 async function timerExample() {
   console.log('Before I/O callbacks');
   await setImmediatePromise();

doc/api/util.md

@@ -758,7 +758,7 @@ option properties directly is also supported.
 const util = require('util');
 const arr = Array(101).fill(0);
 
-console.log(arr); // logs the truncated array
+console.log(arr); // Logs the truncated array
 util.inspect.defaultOptions.maxArrayLength = null;
 console.log(arr); // logs the full array
 ```

doc/api/zlib.md

@@ -69,7 +69,7 @@ See [Memory Usage Tuning][] for more information on the speed/memory/compression
 tradeoffs involved in `zlib` usage.
 
 ```js
-// client request example
+// Client request example
 const zlib = require('zlib');
 const http = require('http');
 const fs = require('fs');