Skip to content

Commit 4374d28

Browse files
nschonnitargos
authored andcommitted
doc: use consistent indenting for unordered list items
Address Markdownlint MD007 rule. Default suggestion is 2 space indenting for unordered list items. PR-URL: #29390 Reviewed-By: David Carlier <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 835d1ca commit 4374d28

14 files changed

+287
-287
lines changed

BUILDING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,8 @@ transition before the year-end deadline.
243243
* `gcc` and `g++` >= 6.3 or newer, or
244244
* GNU Make 3.81 or newer
245245
* Python (see note above)
246-
* Python 2.7
247-
* Python 3.5, 3.6, and 3.7 are experimental.
246+
* Python 2.7
247+
* Python 3.5, 3.6, and 3.7 are experimental.
248248

249249
Installation via Linux package manager can be achieved with:
250250

@@ -259,8 +259,8 @@ FreeBSD and OpenBSD users may also need to install `libexecinfo`.
259259

260260
* Xcode Command Line Tools >= 8 for macOS
261261
* Python (see note above)
262-
* Python 2.7
263-
* Python 3.5, 3.6, and 3.7 are experimental.
262+
* Python 2.7
263+
* Python 3.5, 3.6, and 3.7 are experimental.
264264

265265
macOS users can install the `Xcode Command Line Tools` by running
266266
`xcode-select --install`. Alternatively, if you already have the full Xcode

doc/api/http2.md

+51-51
Original file line numberDiff line numberDiff line change
@@ -1970,23 +1970,23 @@ changes:
19701970
exceed this limit will result in a `'frameError'` event being emitted
19711971
and the stream being closed and destroyed.
19721972
* `paddingStrategy` {number} Identifies the strategy used for determining the
1973-
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
1974-
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
1975-
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
1976-
to be applied.
1977-
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
1978-
amount of padding, as determined by the internal implementation, is to
1979-
be applied.
1980-
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
1981-
provided `options.selectPadding()` callback is to be used to determine
1982-
the amount of padding.
1983-
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
1984-
enough padding to ensure that the total frame length, including the
1985-
9-byte header, is a multiple of 8. For each frame, however, there is a
1986-
maximum allowed number of padding bytes that is determined by current
1987-
flow control state and settings. If this maximum is less than the
1988-
calculated amount needed to ensure alignment, the maximum will be used
1989-
and the total frame length will *not* necessarily be aligned at 8 bytes.
1973+
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
1974+
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
1975+
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
1976+
to be applied.
1977+
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
1978+
amount of padding, as determined by the internal implementation, is to
1979+
be applied.
1980+
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
1981+
provided `options.selectPadding()` callback is to be used to determine
1982+
the amount of padding.
1983+
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
1984+
enough padding to ensure that the total frame length, including the
1985+
9-byte header, is a multiple of 8. For each frame, however, there is a
1986+
maximum allowed number of padding bytes that is determined by current
1987+
flow control state and settings. If this maximum is less than the
1988+
calculated amount needed to ensure alignment, the maximum will be used
1989+
and the total frame length will *not* necessarily be aligned at 8 bytes.
19901990
* `peerMaxConcurrentStreams` {number} Sets the maximum number of concurrent
19911991
streams for the remote peer as if a `SETTINGS` frame had been received. Will
19921992
be overridden if the remote peer sets its own value for
@@ -2085,23 +2085,23 @@ changes:
20852085
exceed this limit will result in a `'frameError'` event being emitted
20862086
and the stream being closed and destroyed.
20872087
* `paddingStrategy` {number} Identifies the strategy used for determining the
2088-
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
2089-
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
2090-
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
2091-
to be applied.
2092-
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
2093-
amount of padding, as determined by the internal implementation, is to
2094-
be applied.
2095-
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
2096-
provided `options.selectPadding()` callback is to be used to determine
2097-
the amount of padding.
2098-
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
2099-
enough padding to ensure that the total frame length, including the
2100-
9-byte header, is a multiple of 8. For each frame, however, there is a
2101-
maximum allowed number of padding bytes that is determined by current
2102-
flow control state and settings. If this maximum is less than the
2103-
calculated amount needed to ensure alignment, the maximum will be used
2104-
and the total frame length will *not* necessarily be aligned at 8 bytes.
2088+
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
2089+
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
2090+
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
2091+
to be applied.
2092+
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
2093+
amount of padding, as determined by the internal implementation, is to
2094+
be applied.
2095+
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
2096+
provided `options.selectPadding()` callback is to be used to determine
2097+
the amount of padding.
2098+
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
2099+
enough padding to ensure that the total frame length, including the
2100+
9-byte header, is a multiple of 8. For each frame, however, there is a
2101+
maximum allowed number of padding bytes that is determined by current
2102+
flow control state and settings. If this maximum is less than the
2103+
calculated amount needed to ensure alignment, the maximum will be used
2104+
and the total frame length will *not* necessarily be aligned at 8 bytes.
21052105
* `peerMaxConcurrentStreams` {number} Sets the maximum number of concurrent
21062106
streams for the remote peer as if a `SETTINGS` frame had been received. Will
21072107
be overridden if the remote peer sets its own value for
@@ -2186,23 +2186,23 @@ changes:
21862186
exceed this limit will result in a `'frameError'` event being emitted
21872187
and the stream being closed and destroyed.
21882188
* `paddingStrategy` {number} Identifies the strategy used for determining the
2189-
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
2190-
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
2191-
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
2192-
to be applied.
2193-
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
2194-
amount of padding, as determined by the internal implementation, is to
2195-
be applied.
2196-
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
2197-
provided `options.selectPadding()` callback is to be used to determine
2198-
the amount of padding.
2199-
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
2200-
enough padding to ensure that the total frame length, including the
2201-
9-byte header, is a multiple of 8. For each frame, however, there is a
2202-
maximum allowed number of padding bytes that is determined by current
2203-
flow control state and settings. If this maximum is less than the
2204-
calculated amount needed to ensure alignment, the maximum will be used
2205-
and the total frame length will *not* necessarily be aligned at 8 bytes.
2189+
amount of padding to use for `HEADERS` and `DATA` frames. **Default:**
2190+
`http2.constants.PADDING_STRATEGY_NONE`. Value may be one of:
2191+
* `http2.constants.PADDING_STRATEGY_NONE` - Specifies that no padding is
2192+
to be applied.
2193+
* `http2.constants.PADDING_STRATEGY_MAX` - Specifies that the maximum
2194+
amount of padding, as determined by the internal implementation, is to
2195+
be applied.
2196+
* `http2.constants.PADDING_STRATEGY_CALLBACK` - Specifies that the user
2197+
provided `options.selectPadding()` callback is to be used to determine
2198+
the amount of padding.
2199+
* `http2.constants.PADDING_STRATEGY_ALIGNED` - Will *attempt* to apply
2200+
enough padding to ensure that the total frame length, including the
2201+
9-byte header, is a multiple of 8. For each frame, however, there is a
2202+
maximum allowed number of padding bytes that is determined by current
2203+
flow control state and settings. If this maximum is less than the
2204+
calculated amount needed to ensure alignment, the maximum will be used
2205+
and the total frame length will *not* necessarily be aligned at 8 bytes.
22062206
* `peerMaxConcurrentStreams` {number} Sets the maximum number of concurrent
22072207
streams for the remote peer as if a `SETTINGS` frame had been received. Will
22082208
be overridden if the remote peer sets its own value for

doc/api/process.md

+45-45
Original file line numberDiff line numberDiff line change
@@ -723,8 +723,8 @@ added: v6.1.0
723723
* `previousValue` {Object} A previous return value from calling
724724
`process.cpuUsage()`
725725
* Returns: {Object}
726-
* `user` {integer}
727-
* `system` {integer}
726+
* `user` {integer}
727+
* `system` {integer}
728728

729729
The `process.cpuUsage()` method returns the user and system CPU time usage of
730730
the current process, in an object with properties `user` and `system`, whose
@@ -1450,10 +1450,10 @@ changes:
14501450
-->
14511451

14521452
* Returns: {Object}
1453-
* `rss` {integer}
1454-
* `heapTotal` {integer}
1455-
* `heapUsed` {integer}
1456-
* `external` {integer}
1453+
* `rss` {integer}
1454+
* `heapTotal` {integer}
1455+
* `heapUsed` {integer}
1456+
* `external` {integer}
14571457

14581458
The `process.memoryUsage()` method returns an object describing the memory usage
14591459
of the Node.js process measured in bytes.
@@ -1866,45 +1866,45 @@ added: v12.6.0
18661866
* Returns: {Object} the resource usage for the current process. All of these
18671867
values come from the `uv_getrusage` call which returns
18681868
a [`uv_rusage_t` struct][uv_rusage_t].
1869-
* `userCPUTime` {integer} maps to `ru_utime` computed in microseconds.
1870-
It is the same value as [`process.cpuUsage().user`][process.cpuUsage].
1871-
* `systemCPUTime` {integer} maps to `ru_stime` computed in microseconds.
1872-
It is the same value as [`process.cpuUsage().system`][process.cpuUsage].
1873-
* `maxRSS` {integer} maps to `ru_maxrss` which is the maximum resident set
1874-
size used in kilobytes.
1875-
* `sharedMemorySize` {integer} maps to `ru_ixrss` but is not supported by
1876-
any platform.
1877-
* `unsharedDataSize` {integer} maps to `ru_idrss` but is not supported by
1878-
any platform.
1879-
* `unsharedStackSize` {integer} maps to `ru_isrss` but is not supported by
1880-
any platform.
1881-
* `minorPageFault` {integer} maps to `ru_minflt` which is the number of
1882-
minor page faults for the process, see
1883-
[this article for more details][wikipedia_minor_fault].
1884-
* `majorPageFault` {integer} maps to `ru_majflt` which is the number of
1885-
major page faults for the process, see
1886-
[this article for more details][wikipedia_major_fault]. This field is not
1887-
supported on Windows.
1888-
* `swappedOut` {integer} maps to `ru_nswap` but is not supported by any
1889-
platform.
1890-
* `fsRead` {integer} maps to `ru_inblock` which is the number of times the
1891-
file system had to perform input.
1892-
* `fsWrite` {integer} maps to `ru_oublock` which is the number of times the
1893-
file system had to perform output.
1894-
* `ipcSent` {integer} maps to `ru_msgsnd` but is not supported by any
1895-
platform.
1896-
* `ipcReceived` {integer} maps to `ru_msgrcv` but is not supported by any
1897-
platform.
1898-
* `signalsCount` {integer} maps to `ru_nsignals` but is not supported by any
1899-
platform.
1900-
* `voluntaryContextSwitches` {integer} maps to `ru_nvcsw` which is the
1901-
number of times a CPU context switch resulted due to a process voluntarily
1902-
giving up the processor before its time slice was completed (usually to
1903-
await availability of a resource). This field is not supported on Windows.
1904-
* `involuntaryContextSwitches` {integer} maps to `ru_nivcsw` which is the
1905-
number of times a CPU context switch resulted due to a higher priority
1906-
process becoming runnable or because the current process exceeded its
1907-
time slice. This field is not supported on Windows.
1869+
* `userCPUTime` {integer} maps to `ru_utime` computed in microseconds.
1870+
It is the same value as [`process.cpuUsage().user`][process.cpuUsage].
1871+
* `systemCPUTime` {integer} maps to `ru_stime` computed in microseconds.
1872+
It is the same value as [`process.cpuUsage().system`][process.cpuUsage].
1873+
* `maxRSS` {integer} maps to `ru_maxrss` which is the maximum resident set
1874+
size used in kilobytes.
1875+
* `sharedMemorySize` {integer} maps to `ru_ixrss` but is not supported by
1876+
any platform.
1877+
* `unsharedDataSize` {integer} maps to `ru_idrss` but is not supported by
1878+
any platform.
1879+
* `unsharedStackSize` {integer} maps to `ru_isrss` but is not supported by
1880+
any platform.
1881+
* `minorPageFault` {integer} maps to `ru_minflt` which is the number of
1882+
minor page faults for the process, see
1883+
[this article for more details][wikipedia_minor_fault].
1884+
* `majorPageFault` {integer} maps to `ru_majflt` which is the number of
1885+
major page faults for the process, see
1886+
[this article for more details][wikipedia_major_fault]. This field is not
1887+
supported on Windows.
1888+
* `swappedOut` {integer} maps to `ru_nswap` but is not supported by any
1889+
platform.
1890+
* `fsRead` {integer} maps to `ru_inblock` which is the number of times the
1891+
file system had to perform input.
1892+
* `fsWrite` {integer} maps to `ru_oublock` which is the number of times the
1893+
file system had to perform output.
1894+
* `ipcSent` {integer} maps to `ru_msgsnd` but is not supported by any
1895+
platform.
1896+
* `ipcReceived` {integer} maps to `ru_msgrcv` but is not supported by any
1897+
platform.
1898+
* `signalsCount` {integer} maps to `ru_nsignals` but is not supported by any
1899+
platform.
1900+
* `voluntaryContextSwitches` {integer} maps to `ru_nvcsw` which is the
1901+
number of times a CPU context switch resulted due to a process voluntarily
1902+
giving up the processor before its time slice was completed (usually to
1903+
await availability of a resource). This field is not supported on Windows.
1904+
* `involuntaryContextSwitches` {integer} maps to `ru_nivcsw` which is the
1905+
number of times a CPU context switch resulted due to a higher priority
1906+
process becoming runnable or because the current process exceeded its
1907+
time slice. This field is not supported on Windows.
19081908

19091909
```js
19101910
console.log(process.resourceUsage());

doc/api/url.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1143,9 +1143,9 @@ The formatting process operates as follows:
11431143
colon (`:`) character, the literal string `:` will be appended to `result`.
11441144
* If either of the following conditions is true, then the literal string `//`
11451145
will be appended to `result`:
1146-
* `urlObject.slashes` property is true;
1147-
* `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or
1148-
`file`;
1146+
* `urlObject.slashes` property is true;
1147+
* `urlObject.protocol` begins with `http`, `https`, `ftp`, `gopher`, or
1148+
`file`;
11491149
* If the value of the `urlObject.auth` property is truthy, and either
11501150
`urlObject.host` or `urlObject.hostname` are not `undefined`, the value of
11511151
`urlObject.auth` will be coerced into a string and appended to `result`

0 commit comments

Comments
 (0)