Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: escape brackets not used as markdown reference links #29809

Closed
wants to merge 1 commit into from
Closed

doc: escape brackets not used as markdown reference links #29809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions doc/api/assert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ lax:
assert.deepEqual(/a/gi, new Date());
```

## assert(value[, message])
## assert(value\[, message\])
<!-- YAML
added: v0.5.9
-->
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
-->
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
-->
Expand Down Expand Up @@ -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
-->
Expand All @@ -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:
Expand Down Expand Up @@ -724,7 +724,7 @@ let err;
// at errorFrame
```

## assert.notDeepEqual(actual, expected[, message])
## assert.notDeepEqual(actual, expected\[, message\])
<!-- YAML
added: v0.1.21
changes:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
-->
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -990,7 +990,7 @@ assert(0);
// assert(0)
```

## assert.rejects(asyncFn[, error][, message])
## assert.rejects(asyncFn\[, error\]\[, message\])
<!-- YAML
added: v10.0.0
-->
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -649,7 +649,7 @@ class DBQuery extends AsyncResource {
}
```

#### asyncResource.runInAsyncScope(fn[, thisArg, ...args])
#### asyncResource.runInAsyncScope(fn\[, thisArg, ...args\])
<!-- YAML
added: v9.6.0
-->
Expand Down
Loading