Skip to content
Permalink
Browse files
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>
  • Loading branch information
nschonni authored and targos committed Oct 14, 2019
1 parent f3bf8be commit b916ea3010d914d5867f7caff8ebda56c872f125
@@ -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:
@@ -266,7 +266,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:
@@ -420,7 +420,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
-->
@@ -470,7 +470,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:
@@ -546,7 +546,7 @@ assert.doesNotThrow(
// Throws: AssertionError: Got unwanted exception: Whoops
```

## assert.equal(actual, expected[, message])
## assert.equal(actual, expected\[, message\])
<!-- YAML
added: v0.1.21
-->
@@ -586,7 +586,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
-->
@@ -613,7 +613,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:
@@ -723,7 +723,7 @@ let err;
// at errorFrame
```

## assert.notDeepEqual(actual, expected[, message])
## assert.notDeepEqual(actual, expected\[, message\])
<!-- YAML
added: v0.1.21
changes:
@@ -797,7 +797,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.notDeepStrictEqual(actual, expected[, message])
## assert.notDeepStrictEqual(actual, expected\[, message\])
<!-- YAML
added: v1.2.0
changes:
@@ -845,7 +845,7 @@ a `message` property set equal to the value of the `message` parameter. 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
-->
@@ -884,7 +884,7 @@ 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:
@@ -921,7 +921,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.ok(value[, message])
## assert.ok(value\[, message\])
<!-- YAML
added: v0.1.21
changes:
@@ -989,7 +989,7 @@ assert(0);
// assert(0)
```

## assert.rejects(asyncFn[, error][, message])
## assert.rejects(asyncFn\[, error\]\[, message\])
<!-- YAML
added: v10.0.0
-->
@@ -1048,7 +1048,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:
@@ -1098,7 +1098,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:
@@ -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
-->
Loading

0 comments on commit b916ea3

Please sign in to comment.