Skip to content

Commit 81bc7b3

Browse files
nschonniTrott
authored andcommitted
doc: escape brackets not used as markdown reference links
These can turn into links if reference links are added to the document PR-URL: nodejs#29809 Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent a1e47d7 commit 81bc7b3

Some content is hidden

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

41 files changed

+465
-465
lines changed

doc/api/assert.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ lax:
142142
assert.deepEqual(/a/gi, new Date());
143143
```
144144

145-
## assert(value[, message])
145+
## assert(value\[, message\])
146146
<!-- YAML
147147
added: v0.5.9
148148
-->
@@ -152,7 +152,7 @@ added: v0.5.9
152152

153153
An alias of [`assert.ok()`][].
154154

155-
## assert.deepEqual(actual, expected[, message])
155+
## assert.deepEqual(actual, expected\[, message\])
156156
<!-- YAML
157157
added: v0.1.21
158158
changes:
@@ -267,7 +267,7 @@ parameter is undefined, a default error message is assigned. If the `message`
267267
parameter is an instance of an [`Error`][] then it will be thrown instead of the
268268
[`AssertionError`][].
269269

270-
## assert.deepStrictEqual(actual, expected[, message])
270+
## assert.deepStrictEqual(actual, expected\[, message\])
271271
<!-- YAML
272272
added: v1.2.0
273273
changes:
@@ -421,7 +421,7 @@ parameter is undefined, a default error message is assigned. If the `message`
421421
parameter is an instance of an [`Error`][] then it will be thrown instead of the
422422
`AssertionError`.
423423

424-
## assert.doesNotReject(asyncFn[, error][, message])
424+
## assert.doesNotReject(asyncFn\[, error\]\[, message\])
425425
<!-- YAML
426426
added: v10.0.0
427427
-->
@@ -471,7 +471,7 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value')))
471471
});
472472
```
473473

474-
## assert.doesNotThrow(fn[, error][, message])
474+
## assert.doesNotThrow(fn\[, error\]\[, message\])
475475
<!-- YAML
476476
added: v0.1.21
477477
changes:
@@ -547,7 +547,7 @@ assert.doesNotThrow(
547547
// Throws: AssertionError: Got unwanted exception: Whoops
548548
```
549549

550-
## assert.equal(actual, expected[, message])
550+
## assert.equal(actual, expected\[, message\])
551551
<!-- YAML
552552
added: v0.1.21
553553
-->
@@ -587,7 +587,7 @@ parameter is undefined, a default error message is assigned. If the `message`
587587
parameter is an instance of an [`Error`][] then it will be thrown instead of the
588588
`AssertionError`.
589589

590-
## assert.fail([message])
590+
## assert.fail(\[message\])
591591
<!-- YAML
592592
added: v0.1.21
593593
-->
@@ -614,7 +614,7 @@ assert.fail(new TypeError('need array'));
614614
Using `assert.fail()` with more than two arguments is possible but deprecated.
615615
See below for further details.
616616

617-
## assert.fail(actual, expected[, message[, operator[, stackStartFn]]])
617+
## assert.fail(actual, expected\[, message\[, operator\[, stackStartFn\]\]\])
618618
<!-- YAML
619619
added: v0.1.21
620620
changes:
@@ -724,7 +724,7 @@ let err;
724724
// at errorFrame
725725
```
726726

727-
## assert.notDeepEqual(actual, expected[, message])
727+
## assert.notDeepEqual(actual, expected\[, message\])
728728
<!-- YAML
729729
added: v0.1.21
730730
changes:
@@ -798,7 +798,7 @@ If the values are deeply equal, an [`AssertionError`][] is thrown with a
798798
`message` parameter is an instance of an [`Error`][] then it will be thrown
799799
instead of the `AssertionError`.
800800

801-
## assert.notDeepStrictEqual(actual, expected[, message])
801+
## assert.notDeepStrictEqual(actual, expected\[, message\])
802802
<!-- YAML
803803
added: v1.2.0
804804
changes:
@@ -846,7 +846,7 @@ the `message` parameter is undefined, a default error message is assigned. If
846846
the `message` parameter is an instance of an [`Error`][] then it will be thrown
847847
instead of the [`AssertionError`][].
848848

849-
## assert.notEqual(actual, expected[, message])
849+
## assert.notEqual(actual, expected\[, message\])
850850
<!-- YAML
851851
added: v0.1.21
852852
-->
@@ -885,7 +885,7 @@ parameter is undefined, a default error message is assigned. If the `message`
885885
parameter is an instance of an [`Error`][] then it will be thrown instead of the
886886
`AssertionError`.
887887

888-
## assert.notStrictEqual(actual, expected[, message])
888+
## assert.notStrictEqual(actual, expected\[, message\])
889889
<!-- YAML
890890
added: v0.1.21
891891
changes:
@@ -922,7 +922,7 @@ If the values are strictly equal, an [`AssertionError`][] is thrown with a
922922
`message` parameter is an instance of an [`Error`][] then it will be thrown
923923
instead of the `AssertionError`.
924924

925-
## assert.ok(value[, message])
925+
## assert.ok(value\[, message\])
926926
<!-- YAML
927927
added: v0.1.21
928928
changes:
@@ -990,7 +990,7 @@ assert(0);
990990
// assert(0)
991991
```
992992

993-
## assert.rejects(asyncFn[, error][, message])
993+
## assert.rejects(asyncFn\[, error\]\[, message\])
994994
<!-- YAML
995995
added: v10.0.0
996996
-->
@@ -1049,7 +1049,7 @@ argument, then `error` is assumed to be omitted and the string will be used for
10491049
example in [`assert.throws()`][] carefully if using a string as the second
10501050
argument gets considered.
10511051

1052-
## assert.strictEqual(actual, expected[, message])
1052+
## assert.strictEqual(actual, expected\[, message\])
10531053
<!-- YAML
10541054
added: v0.1.21
10551055
changes:
@@ -1099,7 +1099,7 @@ If the values are not strictly equal, an [`AssertionError`][] is thrown with a
10991099
`message` parameter is an instance of an [`Error`][] then it will be thrown
11001100
instead of the [`AssertionError`][].
11011101

1102-
## assert.throws(fn[, error][, message])
1102+
## assert.throws(fn\[, error\]\[, message\])
11031103
<!-- YAML
11041104
added: v0.1.21
11051105
changes:

doc/api/async_hooks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -615,7 +615,7 @@ asyncResource.asyncId();
615615
asyncResource.triggerAsyncId();
616616
```
617617

618-
#### new AsyncResource(type[, options])
618+
#### new AsyncResource(type\[, options\])
619619

620620
* `type` {string} The type of async event.
621621
* `options` {Object}
@@ -649,7 +649,7 @@ class DBQuery extends AsyncResource {
649649
}
650650
```
651651

652-
#### asyncResource.runInAsyncScope(fn[, thisArg, ...args])
652+
#### asyncResource.runInAsyncScope(fn\[, thisArg, ...args\])
653653
<!-- YAML
654654
added: v9.6.0
655655
-->

0 commit comments

Comments
 (0)