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 <rtrott@gmail.com>
nodejs · Oct 11, 2019 · 81bc7b3 · 81bc7b3
1 parent a1e47d7
commit 81bc7b3
Show file tree

Hide file tree

Showing 41 changed files with 465 additions and 465 deletions.
diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -142,7 +142,7 @@ lax:
 assert.deepEqual(/a/gi, new Date());
 ```
 
-## assert(value[, message])
+## assert(value\[, message\])
 <!-- YAML
 added: v0.5.9
 -->
@@ -152,7 +152,7 @@ added: v0.5.9
 
 An alias of [`assert.ok()`][].
 
-## assert.deepEqual(actual, expected[, message])
+## assert.deepEqual(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -267,7 +267,7 @@ parameter is undefined, a default error message is assigned. If the `message`
 parameter is an instance of an [`Error`][] then it will be thrown instead of the
 [`AssertionError`][].
 
-## assert.deepStrictEqual(actual, expected[, message])
+## assert.deepStrictEqual(actual, expected\[, message\])
 <!-- YAML
 added: v1.2.0
 changes:
@@ -421,7 +421,7 @@ parameter is undefined, a default error message is assigned. If the `message`
 parameter is an instance of an [`Error`][] then it will be thrown instead of the
 `AssertionError`.
 
-## assert.doesNotReject(asyncFn[, error][, message])
+## assert.doesNotReject(asyncFn\[, error\]\[, message\])
 <!-- YAML
 added: v10.0.0
 -->
@@ -471,7 +471,7 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value')))
   });
 ```
 
-## assert.doesNotThrow(fn[, error][, message])
+## assert.doesNotThrow(fn\[, error\]\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -547,7 +547,7 @@ assert.doesNotThrow(
 // Throws: AssertionError: Got unwanted exception: Whoops
 ```
 
-## assert.equal(actual, expected[, message])
+## assert.equal(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 -->
@@ -587,7 +587,7 @@ parameter is undefined, a default error message is assigned. If the `message`
 parameter is an instance of an [`Error`][] then it will be thrown instead of the
 `AssertionError`.
 
-## assert.fail([message])
+## assert.fail(\[message\])
 <!-- YAML
 added: v0.1.21
 -->
@@ -614,7 +614,7 @@ assert.fail(new TypeError('need array'));
 Using `assert.fail()` with more than two arguments is possible but deprecated.
 See below for further details.
 
-## assert.fail(actual, expected[, message[, operator[, stackStartFn]]])
+## assert.fail(actual, expected\[, message\[, operator\[, stackStartFn\]\]\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -724,7 +724,7 @@ let err;
 //     at errorFrame
 ```
 
-## assert.notDeepEqual(actual, expected[, message])
+## assert.notDeepEqual(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -798,7 +798,7 @@ If the values are deeply equal, an [`AssertionError`][] is thrown with a
 `message` parameter is an instance of an [`Error`][] then it will be thrown
 instead of the `AssertionError`.
 
-## assert.notDeepStrictEqual(actual, expected[, message])
+## assert.notDeepStrictEqual(actual, expected\[, message\])
 <!-- YAML
 added: v1.2.0
 changes:
@@ -846,7 +846,7 @@ the `message` parameter is undefined, a default error message is assigned. If
 the `message` parameter is an instance of an [`Error`][] then it will be thrown
 instead of the [`AssertionError`][].
 
-## assert.notEqual(actual, expected[, message])
+## assert.notEqual(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 -->
@@ -885,7 +885,7 @@ parameter is undefined, a default error message is assigned. If the `message`
 parameter is an instance of an [`Error`][] then it will be thrown instead of the
 `AssertionError`.
 
-## assert.notStrictEqual(actual, expected[, message])
+## assert.notStrictEqual(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -922,7 +922,7 @@ If the values are strictly equal, an [`AssertionError`][] is thrown with a
 `message` parameter is an instance of an [`Error`][] then it will be thrown
 instead of the `AssertionError`.
 
-## assert.ok(value[, message])
+## assert.ok(value\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -990,7 +990,7 @@ assert(0);
 //   assert(0)
 ```
 
-## assert.rejects(asyncFn[, error][, message])
+## assert.rejects(asyncFn\[, error\]\[, message\])
 <!-- YAML
 added: v10.0.0
 -->
@@ -1049,7 +1049,7 @@ argument, then `error` is assumed to be omitted and the string will be used for
 example in [`assert.throws()`][] carefully if using a string as the second
 argument gets considered.
 
-## assert.strictEqual(actual, expected[, message])
+## assert.strictEqual(actual, expected\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:
@@ -1099,7 +1099,7 @@ If the values are not strictly equal, an [`AssertionError`][] is thrown with a
 `message` parameter is an instance of an [`Error`][] then it will be thrown
 instead of the [`AssertionError`][].
 
-## assert.throws(fn[, error][, message])
+## assert.throws(fn\[, error\]\[, message\])
 <!-- YAML
 added: v0.1.21
 changes:

diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
@@ -615,7 +615,7 @@ asyncResource.asyncId();
 asyncResource.triggerAsyncId();
 ```
 
-#### new AsyncResource(type[, options])
+#### new AsyncResource(type\[, options\])
 
 * `type` {string} The type of async event.
 * `options` {Object}
@@ -649,7 +649,7 @@ class DBQuery extends AsyncResource {
 }
 ```
 
-#### asyncResource.runInAsyncScope(fn[, thisArg, ...args])
+#### asyncResource.runInAsyncScope(fn\[, thisArg, ...args\])
 <!-- YAML
 added: v9.6.0
 -->