Skip to content

Commit 24011de

Browse files
nschonniTrott
nschonni
authored and
Trott
committed
doc: add explicit bracket for markdown reference links
Use explicit trailing `[]` for reference markdown links to prevent implicit links when references are added to documents. PR-URL: nodejs#29808 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 24d43ca commit 24011de

17 files changed

Lines changed: 93 additions & 91 deletions

‎doc/api/assert.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ All instances contain the built-in `Error` properties (`message` and `name`)
3434
and:
3535

3636
* `actual` {any} Set to the `actual` argument for methods such as
37-
[`assert.strictEqual()`].
37+
[`assert.strictEqual()`][].
3838
* `expected` {any} Set to the `expected` value for methods such as
39-
[`assert.strictEqual()`].
39+
[`assert.strictEqual()`][].
4040
* `generatedMessage` {boolean} Indicates if the message was auto-generated
4141
(`true`) or not.
4242
* `code` {string} Value is always `ERR_ASSERTION` to show that the error is an
@@ -639,7 +639,7 @@ If `message` is falsy, the error message is set as the values of `actual` and
639639
`message` is provided as third argument it will be used as the error message and
640640
the other arguments will be stored as properties on the thrown object. If
641641
`stackStartFn` is provided, all stack frames above that function will be
642-
removed from stacktrace (see [`Error.captureStackTrace`]). If no arguments are
642+
removed from stacktrace (see [`Error.captureStackTrace`][]). If no arguments are
643643
given, the default message `Failed` will be used.
644644

645645
```js

‎doc/api/crypto.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2076,7 +2076,7 @@ and Ed448 are currently supported.
20762076

20772077
If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function
20782078
behaves as if [`keyObject.export()`][] had been called on its result. Otherwise,
2079-
the respective part of the key is returned as a [`KeyObject`].
2079+
the respective part of the key is returned as a [`KeyObject`][].
20802080

20812081
It is recommended to encode public keys as `'spki'` and private keys as
20822082
`'pkcs8'` with encryption for long-term storage:
@@ -2136,7 +2136,7 @@ and Ed448 are currently supported.
21362136

21372137
If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function
21382138
behaves as if [`keyObject.export()`][] had been called on its result. Otherwise,
2139-
the respective part of the key is returned as a [`KeyObject`].
2139+
the respective part of the key is returned as a [`KeyObject`][].
21402140

21412141
When encoding public keys, it is recommended to use `'spki'`. When encoding
21422142
private keys, it is recommended to use `'pks8'` with a strong passphrase, and to

‎doc/api/deprecations.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2516,8 +2516,8 @@ changes:
25162516
25172517
Type: Documentation-only
25182518
2519-
Prefer [`response.socket`][] over [`response.connection`] and
2520-
[`request.socket`][] over [`request.connection`].
2519+
Prefer [`response.socket`][] over [`response.connection`][] and
2520+
[`request.socket`][] over [`request.connection`][].
25212521
25222522
<a id="DEP0134"></a>
25232523
### DEP0134: process._tickCallback

‎doc/api/errors.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -460,12 +460,12 @@ system error.
460460
* {number}
461461

462462
The `error.errno` property is a negative number which corresponds
463-
to the error code defined in [`libuv Error handling`].
463+
to the error code defined in [`libuv Error handling`][].
464464

465465
On Windows the error number provided by the system will be normalized by libuv.
466466

467467
To get the string representation of the error code, use
468-
[`util.getSystemErrorName(error.errno)`].
468+
[`util.getSystemErrorName(error.errno)`][].
469469

470470
### error.info
471471

@@ -1285,8 +1285,8 @@ semantics for determining whether a path can be used is platform-dependent.
12851285
### ERR_INVALID_HANDLE_TYPE
12861286

12871287
An attempt was made to send an unsupported "handle" over an IPC communication
1288-
channel to a child process. See [`subprocess.send()`] and [`process.send()`] for
1289-
more information.
1288+
channel to a child process. See [`subprocess.send()`][] and [`process.send()`][]
1289+
for more information.
12901290

12911291
<a id="ERR_INVALID_HTTP_TOKEN"></a>
12921292
### ERR_INVALID_HTTP_TOKEN
@@ -1438,36 +1438,36 @@ for more information.
14381438
### ERR_MANIFEST_ASSERT_INTEGRITY
14391439

14401440
An attempt was made to load a resource, but the resource did not match the
1441-
integrity defined by the policy manifest. See the documentation for [policy]
1441+
integrity defined by the policy manifest. See the documentation for [policy][]
14421442
manifests for more information.
14431443

14441444
<a id="ERR_MANIFEST_DEPENDENCY_MISSING"></a>
14451445
### ERR_MANIFEST_DEPENDENCY_MISSING
14461446

14471447
An attempt was made to load a resource, but the resource was not listed as a
14481448
dependency from the location that attempted to load it. See the documentation
1449-
for [policy] manifests for more information.
1449+
for [policy][] manifests for more information.
14501450

14511451
<a id="ERR_MANIFEST_INTEGRITY_MISMATCH"></a>
14521452
### ERR_MANIFEST_INTEGRITY_MISMATCH
14531453

14541454
An attempt was made to load a policy manifest, but the manifest had multiple
14551455
entries for a resource which did not match each other. Update the manifest
14561456
entries to match in order to resolve this error. See the documentation for
1457-
[policy] manifests for more information.
1457+
[policy][] manifests for more information.
14581458

14591459
<a id="ERR_MANIFEST_INVALID_RESOURCE_FIELD"></a>
14601460
### ERR_MANIFEST_INVALID_RESOURCE_FIELD
14611461

14621462
A policy manifest resource had an invalid value for one of its fields. Update
14631463
the manifest entry to match in order to resolve this error. See the
1464-
documentation for [policy] manifests for more information.
1464+
documentation for [policy][] manifests for more information.
14651465

14661466
<a id="ERR_MANIFEST_PARSE_POLICY"></a>
14671467
### ERR_MANIFEST_PARSE_POLICY
14681468

14691469
An attempt was made to load a policy manifest, but the manifest was unable to
1470-
be parsed. See the documentation for [policy] manifests for more information.
1470+
be parsed. See the documentation for [policy][] manifests for more information.
14711471

14721472
<a id="ERR_MANIFEST_TDZ"></a>
14731473
### ERR_MANIFEST_TDZ
@@ -1479,7 +1479,7 @@ initialization has not yet taken place. This is likely a bug in Node.js.
14791479
### ERR_MANIFEST_UNKNOWN_ONERROR
14801480

14811481
A policy manifest was loaded, but had an unknown value for its "onerror"
1482-
behavior. See the documentation for [policy] manifests for more information.
1482+
behavior. See the documentation for [policy][] manifests for more information.
14831483

14841484
<a id="ERR_MEMORY_ALLOCATION_FAILED"></a>
14851485
### ERR_MEMORY_ALLOCATION_FAILED

‎doc/api/fs.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3133,7 +3133,7 @@ Using `fs.stat()` to check for the existence of a file before calling
31333133
Instead, user code should open/read/write the file directly and handle the
31343134
error raised if the file is not available.
31353135

3136-
To check if a file exists without manipulating it afterwards, [`fs.access()`]
3136+
To check if a file exists without manipulating it afterwards, [`fs.access()`][]
31373137
is recommended.
31383138

31393139
For example, given the following folder structure:
@@ -3541,12 +3541,13 @@ The recursive option is only supported on macOS and Windows.
35413541
This feature depends on the underlying operating system providing a way
35423542
to be notified of filesystem changes.
35433543

3544-
* On Linux systems, this uses [`inotify(7)`].
3545-
* On BSD systems, this uses [`kqueue(2)`].
3546-
* On macOS, this uses [`kqueue(2)`] for files and [`FSEvents`] for directories.
3547-
* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`].
3548-
* On Windows systems, this feature depends on [`ReadDirectoryChangesW`].
3549-
* On Aix systems, this feature depends on [`AHAFS`], which must be enabled.
3544+
* On Linux systems, this uses [`inotify(7)`][].
3545+
* On BSD systems, this uses [`kqueue(2)`][].
3546+
* On macOS, this uses [`kqueue(2)`][] for files and [`FSEvents`][] for
3547+
directories.
3548+
* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`][].
3549+
* On Windows systems, this feature depends on [`ReadDirectoryChangesW`][].
3550+
* On Aix systems, this feature depends on [`AHAFS`][], which must be enabled.
35503551

35513552
If the underlying functionality is not available for some reason, then
35523553
`fs.watch` will not be able to function. For example, watching files or

‎doc/api/globals.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ Used to handle binary data. See the [buffer section][].
3030

3131
## \_\_dirname
3232

33-
This variable may appear to be global but is not. See [`__dirname`].
33+
This variable may appear to be global but is not. See [`__dirname`][].
3434

3535
## \_\_filename
3636

37-
This variable may appear to be global but is not. See [`__filename`].
37+
This variable may appear to be global but is not. See [`__filename`][].
3838

3939
## clearImmediate(immediateObject)
4040
<!-- YAML
@@ -43,7 +43,7 @@ added: v0.9.1
4343

4444
<!--type=global-->
4545

46-
[`clearImmediate`] is described in the [timers][] section.
46+
[`clearImmediate`][] is described in the [timers][] section.
4747

4848
## clearInterval(intervalObject)
4949
<!-- YAML
@@ -52,7 +52,7 @@ added: v0.0.1
5252

5353
<!--type=global-->
5454

55-
[`clearInterval`] is described in the [timers][] section.
55+
[`clearInterval`][] is described in the [timers][] section.
5656

5757
## clearTimeout(timeoutObject)
5858
<!-- YAML
@@ -61,7 +61,7 @@ added: v0.0.1
6161

6262
<!--type=global-->
6363

64-
[`clearTimeout`] is described in the [timers][] section.
64+
[`clearTimeout`][] is described in the [timers][] section.
6565

6666
## console
6767
<!-- YAML
@@ -76,7 +76,7 @@ Used to print to stdout and stderr. See the [`console`][] section.
7676

7777
## exports
7878

79-
This variable may appear to be global but is not. See [`exports`].
79+
This variable may appear to be global but is not. See [`exports`][].
8080

8181
## global
8282
<!-- YAML
@@ -94,7 +94,7 @@ Node.js this is different. The top-level scope is not the global scope;
9494

9595
## module
9696

97-
This variable may appear to be global but is not. See [`module`].
97+
This variable may appear to be global but is not. See [`module`][].
9898

9999
## process
100100
<!-- YAML
@@ -148,7 +148,7 @@ DataHandler.prototype.load = async function load(key) {
148148

149149
## require()
150150

151-
This variable may appear to be global but is not. See [`require()`].
151+
This variable may appear to be global but is not. See [`require()`][].
152152

153153
## setImmediate(callback[, ...args])
154154
<!-- YAML
@@ -157,7 +157,7 @@ added: v0.9.1
157157

158158
<!-- type=global -->
159159

160-
[`setImmediate`] is described in the [timers][] section.
160+
[`setImmediate`][] is described in the [timers][] section.
161161

162162
## setInterval(callback, delay[, ...args])
163163
<!-- YAML
@@ -166,7 +166,7 @@ added: v0.0.1
166166

167167
<!-- type=global -->
168168

169-
[`setInterval`] is described in the [timers][] section.
169+
[`setInterval`][] is described in the [timers][] section.
170170

171171
## setTimeout(callback, delay[, ...args])
172172
<!-- YAML
@@ -175,7 +175,7 @@ added: v0.0.1
175175

176176
<!-- type=global -->
177177

178-
[`setTimeout`] is described in the [timers][] section.
178+
[`setTimeout`][] is described in the [timers][] section.
179179

180180
## TextDecoder
181181
<!-- YAML

‎doc/api/http.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ the requests to that server, but each one will occur over a new connection.
7171
When a connection is closed by the client or the server, it is removed
7272
from the pool. Any unused sockets in the pool will be unrefed so as not
7373
to keep the Node.js process running when there are no outstanding requests.
74-
(see [`socket.unref()`]).
74+
(see [`socket.unref()`][]).
7575

7676
It is good practice, to [`destroy()`][] an `Agent` instance when it is no
7777
longer in use, because unused sockets consume OS resources.

‎doc/api/http2.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ added: v9.4.0
500500
-->
501501

502502
Calls [`ref()`][`net.Socket.prototype.ref()`] on this `Http2Session`
503-
instance's underlying [`net.Socket`].
503+
instance's underlying [`net.Socket`][].
504504

505505
#### http2session.remoteSettings
506506
<!-- YAML
@@ -613,7 +613,7 @@ added: v9.4.0
613613
-->
614614

615615
Calls [`unref()`][`net.Socket.prototype.unref()`] on this `Http2Session`
616-
instance's underlying [`net.Socket`].
616+
instance's underlying [`net.Socket`][].
617617

618618
### Class: ServerHttp2Session
619619
<!-- YAML
@@ -1757,7 +1757,7 @@ added: v8.4.0
17571757

17581758
Stops the server from establishing new sessions. This does not prevent new
17591759
request streams from being created due to the persistent nature of HTTP/2
1760-
sessions. To gracefully shut down the server, call [`http2session.close()`] on
1760+
sessions. To gracefully shut down the server, call [`http2session.close()`][] on
17611761
all active sessions.
17621762

17631763
If `callback` is provided, it is not invoked until all active sessions have been
@@ -1907,7 +1907,7 @@ added: v8.4.0
19071907

19081908
Stops the server from establishing new sessions. This does not prevent new
19091909
request streams from being created due to the persistent nature of HTTP/2
1910-
sessions. To gracefully shut down the server, call [`http2session.close()`] on
1910+
sessions. To gracefully shut down the server, call [`http2session.close()`][] on
19111911
all active sessions.
19121912

19131913
If `callback` is provided, it is not invoked until all active sessions have been
@@ -3410,7 +3410,7 @@ added: v8.4.0
34103410
* `stream` {ServerHttp2Stream} The newly-created `ServerHttp2Stream` object
34113411

34123412
Call [`http2stream.pushStream()`][] with the given headers, and wrap the
3413-
given [`Http2Stream`] on a newly created `Http2ServerResponse` as the callback
3413+
given [`Http2Stream`][] on a newly created `Http2ServerResponse` as the callback
34143414
parameter if successful. When `Http2ServerRequest` is closed, the callback is
34153415
called with an error `ERR_HTTP2_INVALID_STREAM`.
34163416

‎doc/api/inspector.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ added: v8.0.0
137137
-->
138138

139139
Immediately close the session. All pending message callbacks will be called
140-
with an error. [`session.connect()`] will need to be called to be able to send
140+
with an error. [`session.connect()`][] will need to be called to be able to send
141141
messages again. Reconnected session will lose all inspector state, such as
142142
enabled agents or configured breakpoints.
143143

‎doc/api/process.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ all `'exit'` listeners have finished running the Node.js process will terminate.
8080

8181
The listener callback function is invoked with the exit code specified either
8282
by the [`process.exitCode`][] property, or the `exitCode` argument passed to the
83-
[`process.exit()`] method.
83+
[`process.exit()`][] method.
8484

8585
```js
8686
process.on('exit', (code) => {
@@ -570,8 +570,8 @@ added: v0.1.27
570570

571571
The `process.argv` property returns an array containing the command line
572572
arguments passed when the Node.js process was launched. The first element will
573-
be [`process.execPath`]. See `process.argv0` if access to the original value of
574-
`argv[0]` is needed. The second element will be the path to the JavaScript
573+
be [`process.execPath`][]. See `process.argv0` if access to the original value
574+
of `argv[0]` is needed. The second element will be the path to the JavaScript
575575
file being executed. The remaining elements will be any additional command line
576576
arguments.
577577

@@ -1122,7 +1122,7 @@ added: v0.1.13
11221122
The `process.exit()` method instructs Node.js to terminate the process
11231123
synchronously with an exit status of `code`. If `code` is omitted, exit uses
11241124
either the 'success' code `0` or the value of `process.exitCode` if it has been
1125-
set. Node.js will not terminate until all the [`'exit'`] event listeners are
1125+
set. Node.js will not terminate until all the [`'exit'`][] event listeners are
11261126
called.
11271127

11281128
To exit with a 'failure' code:
@@ -1506,7 +1506,7 @@ changes:
15061506
fully drained after the current operation on the JavaScript stack runs to
15071507
completion and before the event loop is allowed to continue. It's possible to
15081508
create an infinite loop if one were to recursively call `process.nextTick()`.
1509-
See the [Event Loop] guide for more background.
1509+
See the [Event Loop][] guide for more background.
15101510

15111511
```js
15121512
console.log('start');

0 commit comments

Comments
 (0)