Skip to content

Commit d66cb4a

Browse files
committed
benchmark,doc,lib,test: capitalize comments
This updates a lot of comments. PR-URL: #26223 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Anto Aravinth <[email protected]>
1 parent 3f4b27d commit d66cb4a

File tree

202 files changed

+348
-349
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+348
-349
lines changed

.eslintrc.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ module.exports = {
6060
'brace-style': ['error', '1tbs', { allowSingleLine: true }],
6161
'capitalized-comments': ['error', 'always', {
6262
line: {
63-
// Ignore all lines that have less characters than 50 and all lines that
63+
// Ignore all lines that have less characters than 40 and all lines that
6464
// start with something that looks like a variable name or code.
65-
ignorePattern: '^.{0,50}$|^ [a-z]+ ?[0-9A-Z_.(/=:[#-]',
65+
ignorePattern: '^.{0,40}$|^ [a-z]+ ?[0-9A-Z_.(/=:[#-]|^ std',
6666
ignoreInlineComments: true,
6767
ignoreConsecutiveComments: true,
6868
},

benchmark/_cli.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ function CLI(usage, settings) {
2828
}
2929

3030
let currentOptional = null;
31-
let mode = 'both'; // possible states are: [both, option, item]
31+
let mode = 'both'; // Possible states are: [both, option, item]
3232

3333
for (const arg of process.argv.slice(2)) {
3434
if (arg === '--') {
@@ -59,7 +59,7 @@ function CLI(usage, settings) {
5959
this.optional[currentOptional] = arg;
6060
}
6161

62-
// the next value can be either an option or an item
62+
// The next value can be either an option or an item
6363
mode = 'both';
6464
} else if (['both', 'item'].includes(mode)) {
6565
// item arguments

benchmark/crypto/cipher-stream.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ function main({ api, cipher, type, len, writes }) {
1515
cipher = 'AES192';
1616
if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) {
1717
console.error('Crypto streams not available until v0.10');
18-
// use the legacy, just so that we can compare them.
18+
// Use the legacy, just so that we can compare them.
1919
api = 'legacy';
2020
}
2121

benchmark/crypto/hash-stream-creation.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const bench = common.createBenchmark(main, {
1616
function main({ api, type, len, out, writes, algo }) {
1717
if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) {
1818
console.error('Crypto streams not available until v0.10');
19-
// use the legacy, just so that we can compare them.
19+
// Use the legacy, just so that we can compare them.
2020
api = 'legacy';
2121
}
2222

@@ -54,7 +54,7 @@ function legacyWrite(algo, message, encoding, writes, len, outEnc) {
5454
h.update(message, encoding);
5555
var res = h.digest(outEnc);
5656

57-
// include buffer creation costs for older versions
57+
// Include buffer creation costs for older versions
5858
if (outEnc === 'buffer' && typeof res === 'string')
5959
res = Buffer.from(res, 'binary');
6060
}

benchmark/crypto/hash-stream-throughput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const bench = common.createBenchmark(main, {
1515
function main({ api, type, len, algo, writes }) {
1616
if (api === 'stream' && /^v0\.[0-8]\./.test(process.version)) {
1717
console.error('Crypto streams not available until v0.10');
18-
// use the legacy, just so that we can compare them.
18+
// Use the legacy, just so that we can compare them.
1919
api = 'legacy';
2020
}
2121

benchmark/crypto/rsa-encrypt-decrypt-throughput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
'use strict';
2-
// throughput benchmark in signing and verifying
2+
// Throughput benchmark in signing and verifying
33
const common = require('../common.js');
44
const crypto = require('crypto');
55
const fs = require('fs');

benchmark/crypto/rsa-sign-verify-throughput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
'use strict';
2-
// throughput benchmark in signing and verifying
2+
// Throughput benchmark in signing and verifying
33
const common = require('../common.js');
44
const crypto = require('crypto');
55
const fs = require('fs');

benchmark/fs/read-stream-throughput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// test the throughput of the fs.WriteStream class.
1+
// Test the throughput of the fs.WriteStream class.
22
'use strict';
33

44
const path = require('path');

benchmark/fs/write-stream-throughput.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// test the throughput of the fs.WriteStream class.
1+
// Test the throughput of the fs.WriteStream class.
22
'use strict';
33

44
const path = require('path');

benchmark/net/tcp-raw-c2s.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
const common = require('../common.js');
66
const util = require('util');
77

8-
// if there are --dur=N and --len=N args, then
8+
// If there are --dur=N and --len=N args, then
99
// run the function with those settings.
1010
// if not, then queue up a bunch of child processes.
1111
const bench = common.createBenchmark(main, {
@@ -36,7 +36,7 @@ function main({ dur, len, type }) {
3636
if (err)
3737
fail(err, 'connect');
3838

39-
// the meat of the benchmark is right here:
39+
// The meat of the benchmark is right here:
4040
bench.start();
4141
var bytes = 0;
4242

0 commit comments

Comments
 (0)