Skip to content

Commit 3e68d21

Browse files
Trottcodebytere
authored andcommitted
doc: use sentence-case for headings in docs
PR-URL: #33889 Backport-PR-URL: #33964 Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 83c9364 commit 3e68d21

Some content is hidden

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

45 files changed

+336
-332
lines changed

doc/api/addons.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# C++ Addons
1+
# C++ addons
22

33
<!--introduced_in=v0.10.0-->
44
<!-- type=misc -->
@@ -395,7 +395,7 @@ only the symbols exported by Node.js will be available.
395395
source image. Using this option, the Addon will have access to the full set of
396396
dependencies.
397397

398-
### Loading Addons using `require()`
398+
### Loading addons using `require()`
399399

400400
The filename extension of the compiled Addon binary is `.node` (as opposed
401401
to `.dll` or `.so`). The [`require()`][require] function is written to look for
@@ -410,7 +410,7 @@ there is a file `addon.js` in the same directory as the binary `addon.node`,
410410
then [`require('addon')`][require] will give precedence to the `addon.js` file
411411
and load it instead.
412412

413-
## Native Abstractions for Node.js
413+
## Native abstractions for Node.js
414414

415415
Each of the examples illustrated in this document make direct use of the
416416
Node.js and V8 APIs for implementing Addons. The V8 API can, and has, changed

doc/api/async_hooks.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Async Hooks
1+
# Async hooks
22

33
<!--introduced_in=v8.1.0-->
44

@@ -127,7 +127,7 @@ class MyAddedCallbacks extends MyAsyncCallbacks {
127127
const asyncHook = async_hooks.createHook(new MyAddedCallbacks());
128128
```
129129

130-
##### Error Handling
130+
##### Error handling
131131

132132
If any `AsyncHook` callbacks throw, the application will print the stack trace
133133
and exit. The exit path does follow that of an uncaught exception, but
@@ -201,7 +201,7 @@ be called again until enabled.
201201

202202
For API consistency `disable()` also returns the `AsyncHook` instance.
203203

204-
#### Hook Callbacks
204+
#### Hook callbacks
205205

206206
Key events in the lifetime of asynchronous events have been categorized into
207207
four areas: instantiation, before/after the callback is called, and when the
@@ -631,7 +631,7 @@ only on chained promises. That means promises not created by `then()`/`catch()`
631631
will not have the `before` and `after` callbacks fired on them. For more details
632632
see the details of the V8 [PromiseHooks][] API.
633633

634-
## JavaScript Embedder API
634+
## JavaScript embedder API
635635

636636
Library developers that handle their own asynchronous resources performing tasks
637637
like I/O, connection pooling, or managing callback queues may use the

doc/api/buffer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ const buf6 = Buffer.from('tést');
5353
const buf7 = Buffer.from('tést', 'latin1');
5454
```
5555

56-
## Buffers and Character Encodings
56+
## Buffers and character encodings
5757
<!-- YAML
5858
changes:
5959
- version: v6.4.0
@@ -2635,7 +2635,7 @@ deprecated: v6.0.0
26352635

26362636
See [`Buffer.allocUnsafeSlow()`][].
26372637

2638-
## Buffer Constants
2638+
## Buffer constants
26392639
<!-- YAML
26402640
added: v8.2.0
26412641
-->

doc/api/child_process.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Child Process
1+
# Child process
22

33
<!--introduced_in=v0.10.0-->
44

@@ -70,7 +70,7 @@ For certain use cases, such as automating shell scripts, the
7070
the synchronous methods can have significant impact on performance due to
7171
stalling the event loop while spawned processes complete.
7272

73-
## Asynchronous Process Creation
73+
## Asynchronous process creation
7474

7575
The [`child_process.spawn()`][], [`child_process.fork()`][], [`child_process.exec()`][],
7676
and [`child_process.execFile()`][] methods all follow the idiomatic asynchronous
@@ -153,7 +153,7 @@ changes:
153153
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
154154
* `encoding` {string} **Default:** `'utf8'`
155155
* `shell` {string} Shell to execute the command with. See
156-
[Shell Requirements][] and [Default Windows Shell][]. **Default:**
156+
[Shell requirements][] and [Default Windows shell][]. **Default:**
157157
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
158158
* `timeout` {number} **Default:** `0`
159159
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
@@ -270,8 +270,8 @@ changes:
270270
done on Windows. Ignored on Unix. **Default:** `false`.
271271
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
272272
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
273-
shell can be specified as a string. See [Shell Requirements][] and
274-
[Default Windows Shell][]. **Default:** `false` (no shell).
273+
shell can be specified as a string. See [Shell requirements][] and
274+
[Default Windows shell][]. **Default:** `false` (no shell).
275275
* `callback` {Function} Called with the output when process terminates.
276276
* `error` {Error}
277277
* `stdout` {string|Buffer}
@@ -353,7 +353,7 @@ changes:
353353
**Default:** `process.execArgv`.
354354
* `serialization` {string} Specify the kind of serialization used for sending
355355
messages between processes. Possible values are `'json'` and `'advanced'`.
356-
See [Advanced Serialization][] for more details. **Default:** `'json'`.
356+
See [Advanced serialization][] for more details. **Default:** `'json'`.
357357
* `silent` {boolean} If `true`, stdin, stdout, and stderr of the child will be
358358
piped to the parent, otherwise they will be inherited from the parent, see
359359
the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s
@@ -430,11 +430,11 @@ changes:
430430
* `gid` {number} Sets the group identity of the process (see setgid(2)).
431431
* `serialization` {string} Specify the kind of serialization used for sending
432432
messages between processes. Possible values are `'json'` and `'advanced'`.
433-
See [Advanced Serialization][] for more details. **Default:** `'json'`.
433+
See [Advanced serialization][] for more details. **Default:** `'json'`.
434434
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
435435
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
436-
shell can be specified as a string. See [Shell Requirements][] and
437-
[Default Windows Shell][]. **Default:** `false` (no shell).
436+
shell can be specified as a string. See [Shell requirements][] and
437+
[Default Windows shell][]. **Default:** `false` (no shell).
438438
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
439439
done on Windows. Ignored on Unix. This is set to `true` automatically
440440
when `shell` is specified and is CMD. **Default:** `false`.
@@ -695,7 +695,7 @@ see [V8 issue 7381](https://bugs.chromium.org/p/v8/issues/detail?id=7381).
695695

696696
See also: [`child_process.exec()`][] and [`child_process.fork()`][].
697697

698-
## Synchronous Process Creation
698+
## Synchronous process creation
699699

700700
The [`child_process.spawnSync()`][], [`child_process.execSync()`][], and
701701
[`child_process.execFileSync()`][] methods are synchronous and will block the
@@ -751,8 +751,8 @@ changes:
751751
normally be created on Windows systems. **Default:** `false`.
752752
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
753753
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
754-
shell can be specified as a string. See [Shell Requirements][] and
755-
[Default Windows Shell][]. **Default:** `false` (no shell).
754+
shell can be specified as a string. See [Shell requirements][] and
755+
[Default Windows shell][]. **Default:** `false` (no shell).
756756
* Returns: {Buffer|string} The stdout from the command.
757757

758758
The `child_process.execFileSync()` method is generally identical to
@@ -800,7 +800,7 @@ changes:
800800
**Default:** `'pipe'`.
801801
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
802802
* `shell` {string} Shell to execute the command with. See
803-
[Shell Requirements][] and [Default Windows Shell][]. **Default:**
803+
[Shell requirements][] and [Default Windows shell][]. **Default:**
804804
`'/bin/sh'` on Unix, `process.env.ComSpec` on Windows.
805805
* `uid` {number} Sets the user identity of the process. (See setuid(2)).
806806
* `gid` {number} Sets the group identity of the process. (See setgid(2)).
@@ -880,8 +880,8 @@ changes:
880880
**Default:** `'buffer'`.
881881
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
882882
`'/bin/sh'` on Unix, and `process.env.ComSpec` on Windows. A different
883-
shell can be specified as a string. See [Shell Requirements][] and
884-
[Default Windows Shell][]. **Default:** `false` (no shell).
883+
shell can be specified as a string. See [Shell requirements][] and
884+
[Default Windows shell][]. **Default:** `false` (no shell).
885885
* `windowsVerbatimArguments` {boolean} No quoting or escaping of arguments is
886886
done on Windows. Ignored on Unix. This is set to `true` automatically
887887
when `shell` is specified and is CMD. **Default:** `false`.
@@ -1021,7 +1021,7 @@ message might not be the same as what is originally sent.
10211021
If the `serialization` option was set to `'advanced'` used when spawning the
10221022
child process, the `message` argument can contain data that JSON is not able
10231023
to represent.
1024-
See [Advanced Serialization][] for more details.
1024+
See [Advanced serialization][] for more details.
10251025

10261026
### `subprocess.channel`
10271027
<!-- YAML
@@ -1520,21 +1520,21 @@ This impacts output that includes multibyte character encodings such as UTF-8 or
15201520
UTF-16. For instance, `console.log('中文测试')` will send 13 UTF-8 encoded bytes
15211521
to `stdout` although there are only 4 characters.
15221522

1523-
## Shell Requirements
1523+
## Shell requirements
15241524

15251525
The shell should understand the `-c` switch. If the shell is `'cmd.exe'`, it
15261526
should understand the `/d /s /c` switches and command line parsing should be
15271527
compatible.
15281528

1529-
## Default Windows Shell
1529+
## Default Windows shell
15301530

15311531
Although Microsoft specifies `%COMSPEC%` must contain the path to
15321532
`'cmd.exe'` in the root environment, child processes are not always subject to
15331533
the same requirement. Thus, in `child_process` functions where a shell can be
15341534
spawned, `'cmd.exe'` is used as a fallback if `process.env.ComSpec` is
15351535
unavailable.
15361536

1537-
## Advanced Serialization
1537+
## Advanced serialization
15381538
<!-- YAML
15391539
added: v12.16.0
15401540
-->
@@ -1553,7 +1553,7 @@ Therefore, this feature requires opting in by setting the
15531553
`serialization` option to `'advanced'` when calling [`child_process.spawn()`][]
15541554
or [`child_process.fork()`][].
15551555

1556-
[Advanced Serialization]: #child_process_advanced_serialization
1556+
[Advanced serialization]: #child_process_advanced_serialization
15571557
[`'disconnect'`]: process.html#process_event_disconnect
15581558
[`'error'`]: #child_process_event_error
15591559
[`'exit'`]: #child_process_event_exit
@@ -1586,8 +1586,8 @@ or [`child_process.fork()`][].
15861586
[`subprocess.stdio`]: #child_process_subprocess_stdio
15871587
[`subprocess.stdout`]: #child_process_subprocess_stdout
15881588
[`util.promisify()`]: util.html#util_util_promisify_original
1589-
[Default Windows Shell]: #child_process_default_windows_shell
1589+
[Default Windows shell]: #child_process_default_windows_shell
15901590
[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
1591-
[Shell Requirements]: #child_process_shell_requirements
1591+
[Shell requirements]: #child_process_shell_requirements
15921592
[synchronous counterparts]: #child_process_synchronous_process_creation
15931593
[v8.serdes]: v8.html#v8_serialization_api

doc/api/cli.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Command Line Options
1+
# Command line options
22

33
<!--introduced_in=v5.9.1-->
44
<!--type=misc-->
@@ -160,7 +160,7 @@ added: v12.12.0
160160

161161
> Stability: 1 - Experimental
162162
163-
Enable experimental Source Map V3 support for stack traces.
163+
Enable experimental Source Map v3 support for stack traces.
164164

165165
Currently, overriding `Error.prepareStackTrace` is ignored when the
166166
`--enable-source-maps` flag is set.
@@ -1051,7 +1051,7 @@ added: v0.1.3
10511051

10521052
Print node's version.
10531053

1054-
## Environment Variables
1054+
## Environment variables
10551055

10561056
### `NODE_DEBUG=module[,…]`
10571057
<!-- YAML
@@ -1315,7 +1315,7 @@ easier to instrument applications that call the `child_process.spawn()` family
13151315
of functions. `NODE_V8_COVERAGE` can be set to an empty string, to prevent
13161316
propagation.
13171317

1318-
#### Coverage Output
1318+
#### Coverage output
13191319

13201320
Coverage is output as an array of [ScriptCoverage][] objects on the top-level
13211321
key `result`:
@@ -1332,16 +1332,16 @@ key `result`:
13321332
}
13331333
```
13341334

1335-
#### Source Map Cache
1335+
#### Source map cache
13361336

13371337
> Stability: 1 - Experimental
13381338
1339-
If found, Source Map data is appended to the top-level key `source-map-cache`
1339+
If found, source map data is appended to the top-level key `source-map-cache`
13401340
on the JSON coverage object.
13411341

13421342
`source-map-cache` is an object with keys representing the files source maps
13431343
were extracted from, and values which include the raw source-map URL
1344-
(in the key `url`), the parsed Source Map V3 information (in the key `data`),
1344+
(in the key `url`), the parsed Source Map v3 information (in the key `data`),
13451345
and the line lengths of the source file (in the key `lineLengths`).
13461346

13471347
```json
@@ -1450,7 +1450,7 @@ options are of interest only to V8 developers. Despite this, there is a small
14501450
set of V8 options that are widely applicable to Node.js, and they are
14511451
documented here:
14521452

1453-
### `--max-old-space-size=SIZE` (in Mbytes)
1453+
### `--max-old-space-size=SIZE` (in megabytes)
14541454

14551455
Sets the max memory size of V8's old memory section. As memory
14561456
consumption approaches the limit, V8 will spend more time on

doc/api/cluster.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Worker 5644 started
5252

5353
On Windows, it is not yet possible to set up a named pipe server in a worker.
5454

55-
## How It Works
55+
## How it works
5656

5757
<!--type=misc-->
5858

@@ -751,7 +751,7 @@ changes:
751751
`undefined` (inherits from parent process).
752752
* `serialization` {string} Specify the kind of serialization used for sending
753753
messages between processes. Possible values are `'json'` and `'advanced'`.
754-
See [Advanced Serialization for `child_process`][] for more details.
754+
See [Advanced serialization for `child_process`][] for more details.
755755
**Default:** `false`.
756756
* `silent` {boolean} Whether or not to send output to parent's stdio.
757757
**Default:** `false`.
@@ -881,5 +881,5 @@ socket.on('data', (id) => {
881881
[`process` event: `'message'`]: process.html#process_event_message
882882
[`server.close()`]: net.html#net_event_close
883883
[`worker.exitedAfterDisconnect`]: #cluster_worker_exitedafterdisconnect
884-
[Advanced Serialization for `child_process`]: child_process.html#child_process_advanced_serialization
884+
[Advanced serialization for `child_process`]: child_process.html#child_process_advanced_serialization
885885
[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options

doc/api/crypto.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1577,7 +1577,7 @@ added: v6.3.0
15771577

15781578
* Returns: {Object} An object containing commonly used constants for crypto and
15791579
security related operations. The specific constants currently defined are
1580-
described in [Crypto Constants][].
1580+
described in [Crypto constants][].
15811581

15821582
### `crypto.DEFAULT_ENCODING`
15831583
<!-- YAML
@@ -3021,7 +3021,7 @@ key may be passed for `key`.
30213021

30223022
## Notes
30233023

3024-
### Legacy Streams API (pre Node.js v0.10)
3024+
### Legacy streams API (prior to Node.js 0.10)
30253025

30263026
The Crypto module was added to Node.js before there was the concept of a
30273027
unified Stream API, and before there were [`Buffer`][] objects for handling
@@ -3032,7 +3032,7 @@ and returned `'latin1'` encoded strings by default rather than `Buffer`s. This
30323032
default was changed after Node.js v0.8 to use [`Buffer`][] objects by default
30333033
instead.
30343034

3035-
### Recent ECDH Changes
3035+
### Recent ECDH changes
30363036

30373037
Usage of `ECDH` with non-dynamically generated key pairs has been simplified.
30383038
Now, [`ecdh.setPrivateKey()`][] can be called with a preselected private key
@@ -3140,12 +3140,12 @@ try {
31403140
console.log(receivedPlaintext);
31413141
```
31423142

3143-
## Crypto Constants
3143+
## Crypto constants
31443144

31453145
The following constants exported by `crypto.constants` apply to various uses of
31463146
the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
31473147

3148-
### OpenSSL Options
3148+
### OpenSSL options
31493149

31503150
<table>
31513151
<tr>
@@ -3301,7 +3301,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
33013301
</tr>
33023302
</table>
33033303

3304-
### OpenSSL Engine Constants
3304+
### OpenSSL engine constants
33053305

33063306
<table>
33073307
<tr>
@@ -3354,7 +3354,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
33543354
</tr>
33553355
</table>
33563356

3357-
### Other OpenSSL Constants
3357+
### Other OpenSSL constants
33583358

33593359
<table>
33603360
<tr>
@@ -3434,7 +3434,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
34343434
</tr>
34353435
</table>
34363436

3437-
### Node.js Crypto Constants
3437+
### Node.js crypto constants
34383438

34393439
<table>
34403440
<tr>
@@ -3504,7 +3504,7 @@ the `crypto`, `tls`, and `https` modules and are generally specific to OpenSSL.
35043504
[AEAD algorithms]: https://en.wikipedia.org/wiki/Authenticated_encryption
35053505
[CCM mode]: #crypto_ccm_mode
35063506
[Caveats]: #crypto_support_for_weak_or_compromised_algorithms
3507-
[Crypto Constants]: #crypto_crypto_constants_1
3507+
[Crypto constants]: #crypto_crypto_constants_1
35083508
[HTML 5.2]: https://www.w3.org/TR/html52/changes.html#features-removed
35093509
[HTML5's `keygen` element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen
35103510
[NIST SP 800-131A]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf

0 commit comments

Comments
 (0)