From 9edce1e12a7b69e7986dd15fce18d6e46590161a Mon Sep 17 00:00:00 2001 From: Ruben Bridgewater Date: Mon, 21 Jan 2019 01:22:27 +0100 Subject: benchmark,doc,lib,test: capitalize comments This updates a lot of comments. PR-URL: https://github.com/nodejs/node/pull/26223 Reviewed-By: Rich Trott Reviewed-By: James M Snell Reviewed-By: Vse Mozhet Byt Reviewed-By: Anto Aravinth --- benchmark/_cli.js | 4 ++-- benchmark/crypto/cipher-stream.js | 2 +- benchmark/crypto/hash-stream-creation.js | 4 ++-- benchmark/crypto/hash-stream-throughput.js | 2 +- benchmark/crypto/rsa-encrypt-decrypt-throughput.js | 2 +- benchmark/crypto/rsa-sign-verify-throughput.js | 2 +- benchmark/fs/read-stream-throughput.js | 2 +- benchmark/fs/write-stream-throughput.js | 2 +- benchmark/net/tcp-raw-c2s.js | 4 ++-- benchmark/net/tcp-raw-pipe.js | 2 +- benchmark/net/tcp-raw-s2c.js | 2 +- 11 files changed, 14 insertions(+), 14 deletions(-) (limited to 'benchmark') diff --git a/benchmark/_cli.js b/benchmark/_cli.js index abd3946944..45e4c7a2bf 100644 --- a/benchmark/_cli.js +++ b/benchmark/_cli.js @@ -28,7 +28,7 @@ function CLI(usage, settings) { } let currentOptional = null; - let mode = 'both'; // possible states are: [both, option, item] + let mode = 'both'; // Possible states are: [both, option, item] for (const arg of process.argv.slice(2)) { if (arg === '--') { @@ -59,7 +59,7 @@ function CLI(usage, settings) { this.optional[currentOptional] = arg; } - // the next value can be either an option or an item + // The next value can be either an option or an item mode = 'both'; } else if (['both', 'item'].includes(mode)) { // item arguments diff --git a/benchmark/crypto/cipher-stream.js b/benchmark/crypto/cipher-stream.js index 584039a1e5..f426a32769 100644 --- a/benchmark/crypto/cipher-stream.js +++ b/benchmark/crypto/cipher-stream.js @@ -15,7 +15,7 @@ function main({ api, cipher, type, len, writes }) { cipher = 'AES192'; if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) { console.error('Crypto streams not available until v0.10'); - // use the legacy, just so that we can compare them. + // Use the legacy, just so that we can compare them. api = 'legacy'; } diff --git a/benchmark/crypto/hash-stream-creation.js b/benchmark/crypto/hash-stream-creation.js index faaa12a9e5..8ffbe148bb 100644 --- a/benchmark/crypto/hash-stream-creation.js +++ b/benchmark/crypto/hash-stream-creation.js @@ -16,7 +16,7 @@ const bench = common.createBenchmark(main, { function main({ api, type, len, out, writes, algo }) { if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) { console.error('Crypto streams not available until v0.10'); - // use the legacy, just so that we can compare them. + // Use the legacy, just so that we can compare them. api = 'legacy'; } @@ -54,7 +54,7 @@ function legacyWrite(algo, message, encoding, writes, len, outEnc) { h.update(message, encoding); var res = h.digest(outEnc); - // include buffer creation costs for older versions + // Include buffer creation costs for older versions if (outEnc === 'buffer' && typeof res === 'string') res = Buffer.from(res, 'binary'); } diff --git a/benchmark/crypto/hash-stream-throughput.js b/benchmark/crypto/hash-stream-throughput.js index 934e7a0b11..6ce7a6767e 100644 --- a/benchmark/crypto/hash-stream-throughput.js +++ b/benchmark/crypto/hash-stream-throughput.js @@ -15,7 +15,7 @@ const bench = common.createBenchmark(main, { function main({ api, type, len, algo, writes }) { if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) { console.error('Crypto streams not available until v0.10'); - // use the legacy, just so that we can compare them. + // Use the legacy, just so that we can compare them. api = 'legacy'; } diff --git a/benchmark/crypto/rsa-encrypt-decrypt-throughput.js b/benchmark/crypto/rsa-encrypt-decrypt-throughput.js index 1295ac8506..13153c20ca 100644 --- a/benchmark/crypto/rsa-encrypt-decrypt-throughput.js +++ b/benchmark/crypto/rsa-encrypt-decrypt-throughput.js @@ -1,5 +1,5 @@ 'use strict'; -// throughput benchmark in signing and verifying +// Throughput benchmark in signing and verifying const common = require('../common.js'); const crypto = require('crypto'); const fs = require('fs'); diff --git a/benchmark/crypto/rsa-sign-verify-throughput.js b/benchmark/crypto/rsa-sign-verify-throughput.js index 4ea39d1eb6..846fa1b9a4 100644 --- a/benchmark/crypto/rsa-sign-verify-throughput.js +++ b/benchmark/crypto/rsa-sign-verify-throughput.js @@ -1,5 +1,5 @@ 'use strict'; -// throughput benchmark in signing and verifying +// Throughput benchmark in signing and verifying const common = require('../common.js'); const crypto = require('crypto'); const fs = require('fs'); diff --git a/benchmark/fs/read-stream-throughput.js b/benchmark/fs/read-stream-throughput.js index bce5f5c996..cb5d98dc32 100644 --- a/benchmark/fs/read-stream-throughput.js +++ b/benchmark/fs/read-stream-throughput.js @@ -1,4 +1,4 @@ -// test the throughput of the fs.WriteStream class. +// Test the throughput of the fs.WriteStream class. 'use strict'; const path = require('path'); diff --git a/benchmark/fs/write-stream-throughput.js b/benchmark/fs/write-stream-throughput.js index a1daa619a3..bc88330929 100644 --- a/benchmark/fs/write-stream-throughput.js +++ b/benchmark/fs/write-stream-throughput.js @@ -1,4 +1,4 @@ -// test the throughput of the fs.WriteStream class. +// Test the throughput of the fs.WriteStream class. 'use strict'; const path = require('path'); diff --git a/benchmark/net/tcp-raw-c2s.js b/benchmark/net/tcp-raw-c2s.js index 849b365168..fe320ddaa2 100644 --- a/benchmark/net/tcp-raw-c2s.js +++ b/benchmark/net/tcp-raw-c2s.js @@ -5,7 +5,7 @@ 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. const bench = common.createBenchmark(main, { @@ -36,7 +36,7 @@ function main({ dur, len, type }) { if (err) fail(err, 'connect'); - // the meat of the benchmark is right here: + // The meat of the benchmark is right here: bench.start(); var bytes = 0; diff --git a/benchmark/net/tcp-raw-pipe.js b/benchmark/net/tcp-raw-pipe.js index 10c69fb8b2..89db42dc4f 100644 --- a/benchmark/net/tcp-raw-pipe.js +++ b/benchmark/net/tcp-raw-pipe.js @@ -5,7 +5,7 @@ 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. const bench = common.createBenchmark(main, { diff --git a/benchmark/net/tcp-raw-s2c.js b/benchmark/net/tcp-raw-s2c.js index d34434a3d0..73f4d292cf 100644 --- a/benchmark/net/tcp-raw-s2c.js +++ b/benchmark/net/tcp-raw-s2c.js @@ -122,7 +122,7 @@ function main({ dur, len, type }) { clientHandle.readStart(); - // the meat of the benchmark is right here: + // The meat of the benchmark is right here: bench.start(); setTimeout(() => { -- cgit v1.2.3