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.

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

doc: allow <code> in header elements #31086

Merged
merged 44 commits into from Dec 27, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
fdec6bd
doc: allow <code> in header elements
Trott Dec 23, 2019
5998523
doc,dns: use code markup/markdown in headers
Trott Dec 23, 2019
d0f9585
doc: use code markup/markdown in headers in addons documentation
Trott Dec 23, 2019
b5834a4
doc,assert: use code markup/markdown in headers
Trott Dec 23, 2019
a5eb139
doc,async_hooks: use code markup/markdown in headers
Trott Dec 23, 2019
5847a4d
doc,buffer: use code markup/markdown in headers
Trott Dec 23, 2019
19419a4
doc,child_process: use code markup/markdown in headers
Trott Dec 23, 2019
4459988
doc,cluster: use code markup/markdown in headers
Trott Dec 24, 2019
adc9fa2
doc,console: use code markup/markdown in headers
Trott Dec 24, 2019
f6b6701
doc,crypto: use code markup/markdown in headers
Trott Dec 24, 2019
8e7d61e
doc: use code markup/markdown in headers in deprecations documentation
Trott Dec 24, 2019
0c8ff7c
doc,dgram: use code markup/markdown in headers
Trott Dec 24, 2019
75ab328
doc,domain: use code markup/markdown in headers
Trott Dec 24, 2019
57f7537
doc,errors: use code markup/markdown in headers
Trott Dec 24, 2019
b3ff048
doc,esm: use code markup/markdown in headers
Trott Dec 24, 2019
36edbde
doc,events: use code markup/markdown in headers
Trott Dec 24, 2019
b407503
doc,fs: use code markup/markdown in headers
Trott Dec 24, 2019
6f5e765
doc: use code markup/markdown in headers in globals documentation
Trott Dec 24, 2019
f8795db
doc,http: use code markup/markdown in headers
Trott Dec 24, 2019
2d6949d
doc,http2: use code markup/markdown in headers
Trott Dec 24, 2019
fe4a7a2
doc,https: use code markup/markdown in headers
Trott Dec 24, 2019
fc94934
doc,inspector: use code markup/markdown in headers
Trott Dec 24, 2019
248f057
doc,module: use code markup/markdown in headers
Trott Dec 24, 2019
933fd9b
doc,net: use code markup/markdown in headers
Trott Dec 24, 2019
24f24d9
doc,os: use code markup/markdown in headers
Trott Dec 24, 2019
a70c3ab
doc,path: use code markup/markdown in headers
Trott Dec 24, 2019
c956cab
doc,perf_hooks: use code markup/markdown in headers
Trott Dec 24, 2019
fc0aa3f
doc,process: use code markup/markdown in headers
Trott Dec 24, 2019
1c33523
doc,punycode: use code markup/markdown in headers
Trott Dec 24, 2019
d592efe
doc,querystring: use code markup/markdown in headers
Trott Dec 24, 2019
8b89c89
doc,readline: use code markup/markdown in headers
Trott Dec 24, 2019
85aed3e
doc,repl: use code markup/markdown in headers
Trott Dec 24, 2019
7034a3e
doc,stream: use code markup/markdown in headers
Trott Dec 24, 2019
cdb727d
doc,string_decoder: use code markup/markdown in headers
Trott Dec 24, 2019
7bb1f47
doc,timers: use code markup/markdown in headers
Trott Dec 24, 2019
e11b327
doc,tls: use code markup/markdown in headers
Trott Dec 24, 2019
a80d4ac
doc,tty: use code markup/markdown in headers
Trott Dec 24, 2019
79f6412
doc,url: use code markup/markdown in headers
Trott Dec 24, 2019
d9004da
doc,zlib: use code markup/markdown in headers
Trott Dec 24, 2019
ff6e7a0
doc,util: use code markup/markdown in headers
Trott Dec 24, 2019
ae4cd76
doc,v8: use code markup/markdown in headers
Trott Dec 24, 2019
deb0c81
doc,worker: use code markup/markdown in headers
Trott Dec 24, 2019
257a5dd
doc,vm: use code markup/markdown in headers
Trott Dec 25, 2019
b46efa9
doc,wasi: use code markup/markdown in headers
Trott Dec 25, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/addons.md
Expand Up @@ -392,7 +392,7 @@ only the symbols exported by Node.js will be available.
source image. Using this option, the Addon will have access to the full set of
dependencies.

### Loading Addons using require()
### Loading Addons using `require()`

The filename extension of the compiled Addon binary is `.node` (as opposed
to `.dll` or `.so`). The [`require()`][require] function is written to look for
Expand Down
36 changes: 18 additions & 18 deletions doc/api/assert.md
Expand Up @@ -15,7 +15,7 @@ lenient legacy mode.
Indicates the failure of an assertion. All errors thrown by the `assert` module
will be instances of the `AssertionError` class.

### new assert.AssertionError(options)
### `new assert.AssertionError(options)`
<!-- YAML
added: v0.1.21
-->
Expand Down Expand Up @@ -146,7 +146,7 @@ lax:
assert.deepEqual(/a/gi, new Date());
```

## assert(value\[, message\])
## `assert(value[, message])`
<!-- YAML
added: v0.5.9
-->
Expand All @@ -156,7 +156,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 @@ -276,7 +276,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 @@ -430,7 +430,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 @@ -480,7 +480,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 @@ -556,7 +556,7 @@ assert.doesNotThrow(
// Throws: AssertionError: Got unwanted exception: Whoops
```

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

## assert.ifError(value)
## `assert.ifError(value)`
<!-- YAML
added: v0.1.97
changes:
Expand Down Expand Up @@ -741,7 +741,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 @@ -819,7 +819,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 @@ -867,7 +867,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
changes:
Expand Down Expand Up @@ -912,7 +912,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 @@ -949,7 +949,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 @@ -1017,7 +1017,7 @@ assert(0);
// assert(0)
```

## assert.rejects(asyncFn\[, error\]\[, message\])
## `assert.rejects(asyncFn[, error][, message])`
<!-- YAML
added: v10.0.0
-->
Expand Down Expand Up @@ -1076,7 +1076,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 @@ -1126,7 +1126,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
32 changes: 16 additions & 16 deletions doc/api/async_hooks.md
Expand Up @@ -78,7 +78,7 @@ function destroy(asyncId) { }
function promiseResolve(asyncId) { }
```

#### async_hooks.createHook(callbacks)
#### `async_hooks.createHook(callbacks)`

<!-- YAML
added: v8.1.0
Expand Down Expand Up @@ -171,7 +171,7 @@ provided by AsyncHooks itself. The logging should then be skipped when
it was the logging itself that caused AsyncHooks callback to call. By
doing this the otherwise infinite recursion is broken.

#### asyncHook.enable()
#### `asyncHook.enable()`

* Returns: {AsyncHook} A reference to `asyncHook`.

Expand All @@ -187,7 +187,7 @@ const async_hooks = require('async_hooks');
const hook = async_hooks.createHook(callbacks).enable();
```

#### asyncHook.disable()
#### `asyncHook.disable()`

* Returns: {AsyncHook} A reference to `asyncHook`.

Expand All @@ -203,7 +203,7 @@ Key events in the lifetime of asynchronous events have been categorized into
four areas: instantiation, before/after the callback is called, and when the
instance is destroyed.

##### init(asyncId, type, triggerAsyncId, resource)
##### `init(asyncId, type, triggerAsyncId, resource)`

* `asyncId` {number} A unique ID for the async resource.
* `type` {string} The type of the async resource.
Expand Down Expand Up @@ -390,7 +390,7 @@ API the user's callback is placed in a `process.nextTick()`.
The graph only shows *when* a resource was created, not *why*, so to track
the *why* use `triggerAsyncId`.

##### before(asyncId)
##### `before(asyncId)`

* `asyncId` {number}

Expand All @@ -407,7 +407,7 @@ asynchronous resources like a TCP server will typically call the `before`
callback multiple times, while other operations like `fs.open()` will call
it only once.

##### after(asyncId)
##### `after(asyncId)`

* `asyncId` {number}

Expand All @@ -417,7 +417,7 @@ If an uncaught exception occurs during execution of the callback, then `after`
will run *after* the `'uncaughtException'` event is emitted or a `domain`'s
handler runs.

##### destroy(asyncId)
##### `destroy(asyncId)`

* `asyncId` {number}

Expand All @@ -429,7 +429,7 @@ made to the `resource` object passed to `init` it is possible that `destroy`
will never be called, causing a memory leak in the application. If the resource
does not depend on garbage collection, then this will not be an issue.

##### promiseResolve(asyncId)
##### `promiseResolve(asyncId)`

<!-- YAML
added: v8.6.0
Expand Down Expand Up @@ -460,7 +460,7 @@ init for PROMISE with id 6, trigger id: 5 # the Promise returned by then()
after 6
```

#### async_hooks.executionAsyncId()
#### `async_hooks.executionAsyncId()`

<!-- YAML
added: v8.1.0
Expand Down Expand Up @@ -501,7 +501,7 @@ const server = net.createServer((conn) => {
Promise contexts may not get precise `executionAsyncIds` by default.
See the section on [promise execution tracking][].

#### async_hooks.triggerAsyncId()
#### `async_hooks.triggerAsyncId()`

* Returns: {number} The ID of the resource responsible for calling the callback
that is currently being executed.
Expand Down Expand Up @@ -577,7 +577,7 @@ Library developers that handle their own asynchronous resources performing tasks
like I/O, connection pooling, or managing callback queues may use the
`AsyncWrap` JavaScript API so that all the appropriate callbacks are called.

### Class: AsyncResource
### Class: `AsyncResource`

The class `AsyncResource` is designed to be extended by the embedder's async
resources. Using this, users can easily trigger the lifetime events of their
Expand Down 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 All @@ -664,7 +664,7 @@ of the async resource. This will establish the context, trigger the AsyncHooks
before callbacks, call the function, trigger the AsyncHooks after callbacks, and
then restore the original execution context.

#### asyncResource.emitDestroy()
#### `asyncResource.emitDestroy()`

* Returns: {AsyncResource} A reference to `asyncResource`.

Expand All @@ -673,11 +673,11 @@ be thrown if it is called more than once. This **must** be manually called. If
the resource is left to be collected by the GC then the `destroy` hooks will
never be called.

#### asyncResource.asyncId()
#### `asyncResource.asyncId()`

* Returns: {number} The unique `asyncId` assigned to the resource.

#### asyncResource.triggerAsyncId()
#### `asyncResource.triggerAsyncId()`

* Returns: {number} The same `triggerAsyncId` that is passed to the
`AsyncResource` constructor.
Expand Down