Skip to content

Commit b916ea3

Browse files
nschonnitargos
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: #29809 Reviewed-By: Rich Trott <[email protected]>
1 parent f3bf8be commit b916ea3

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

Lines changed: 16 additions & 16 deletions
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:
@@ -266,7 +266,7 @@ parameter is undefined, a default error message is assigned. If the `message`
266266
parameter is an instance of an [`Error`][] then it will be thrown instead of the
267267
`AssertionError`.
268268

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

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

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

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

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

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

726-
## assert.notDeepEqual(actual, expected[, message])
726+
## assert.notDeepEqual(actual, expected\[, message\])
727727
<!-- YAML
728728
added: v0.1.21
729729
changes:
@@ -797,7 +797,7 @@ parameter is undefined, a default error message is assigned. If the `message`
797797
parameter is an instance of an [`Error`][] then it will be thrown instead of the
798798
`AssertionError`.
799799

800-
## assert.notDeepStrictEqual(actual, expected[, message])
800+
## assert.notDeepStrictEqual(actual, expected\[, message\])
801801
<!-- YAML
802802
added: v1.2.0
803803
changes:
@@ -845,7 +845,7 @@ a `message` property set equal to the value of the `message` parameter. If the
845845
`message` parameter is an instance of an [`Error`][] then it will be thrown
846846
instead of the `AssertionError`.
847847

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

887-
## assert.notStrictEqual(actual, expected[, message])
887+
## assert.notStrictEqual(actual, expected\[, message\])
888888
<!-- YAML
889889
added: v0.1.21
890890
changes:
@@ -921,7 +921,7 @@ parameter is undefined, a default error message is assigned. If the `message`
921921
parameter is an instance of an [`Error`][] then it will be thrown instead of the
922922
`AssertionError`.
923923

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

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

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

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

doc/api/async_hooks.md

Lines changed: 2 additions & 2 deletions
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)