Skip to content

Commit 9ab1e07

Browse files
nschonniTrott
authored andcommitted
doc: add blanks around code fences
Addresses Markdownlint MD031 rule warnings PR-URL: nodejs#29366 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: David Carlier <[email protected]>
1 parent ee8f02b commit 9ab1e07

23 files changed

+212
-5
lines changed

BUILDING.md

+3
Original file line numberDiff line numberDiff line change
@@ -665,16 +665,19 @@ during configuration if the ICU version is too old.
665665
#### Unix/macOS
666666

667667
From an already-unpacked ICU:
668+
668669
```console
669670
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
670671
```
671672

672673
From a local ICU tarball:
674+
673675
```console
674676
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
675677
```
676678

677679
From a tarball URL:
680+
678681
```console
679682
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
680683
```

CPP_STYLE_GUIDE.md

+1
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,7 @@ class FancyContainer {
185185
...
186186
}
187187
```
188+
188189
## Memory Management
189190

190191
### Memory allocation

doc/api/child_process.md

+1
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ generated output. The `command` string passed to the exec function is processed
168168
directly by the shell and special characters (vary based on
169169
[shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters))
170170
need to be dealt with accordingly:
171+
171172
```js
172173
exec('"/path/to/test file/test.sh" arg1 arg2');
173174
// Double quotes are used so that the space in the path is not interpreted as

doc/api/cli.md

+1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ added: v10.12.0
7070
-->
7171

7272
Print source-able bash completion script for Node.js.
73+
7374
```console
7475
$ node --completion-bash > node_bash_completion
7576
$ source node_bash_completion

doc/api/console.md

+1
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,7 @@ This method does not display anything unless used in the inspector. The
498498
`console.profile()` method starts a JavaScript CPU profile with an optional
499499
label until [`console.profileEnd()`][] is called. The profile is then added to
500500
the **Profile** panel of the inspector.
501+
501502
```js
502503
console.profile('MyLabel');
503504
// Some code

doc/api/crypto.md

+1
Original file line numberDiff line numberDiff line change
@@ -716,6 +716,7 @@ const dh = crypto.createDiffieHellmanGroup(name);
716716
```
717717

718718
`name` is taken from [RFC 2412][] (modp1 and 2) and [RFC 3526][]:
719+
719720
```console
720721
$ perl -ne 'print "$1\n" if /"(modp\d+)"/' src/node_crypto_groups.h
721722
modp1 # 768 bits

doc/api/dgram.md

+1
Original file line numberDiff line numberDiff line change
@@ -528,6 +528,7 @@ socket.bind(1234, () => {
528528

529529
#### Example: IPv4 Outgoing Multicast Interface
530530
All systems use an IP of the host on the desired physical interface:
531+
531532
```js
532533
const socket = dgram.createSocket('udp4');
533534

doc/api/errors.md

+1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:
7070
// Otherwise handle the data
7171
});
7272
```
73+
7374
- When an asynchronous method is called on an object that is an
7475
[`EventEmitter`][], errors can be routed to that object's `'error'` event.
7576

doc/api/esm.md

+1
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ module via `import`.
188188
"main": "./src/index.js"
189189
}
190190
```
191+
191192
```js
192193
// ./my-app.mjs
193194

doc/api/fs.md

+2
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,7 @@ fs.readFileSync(new URL('file:///p/a/t/h/%2f'));
231231
/* TypeError [ERR_INVALID_FILE_URL_PATH]: File URL path must not include encoded
232232
/ characters */
233233
```
234+
234235
On Windows, `file:` URLs having encoded backslash will result in a throw:
235236

236237
```js
@@ -3815,6 +3816,7 @@ recommended.
38153816

38163817
When `file` is a file descriptor, the behavior is almost identical to directly
38173818
calling `fs.write()` like:
3819+
38183820
```javascript
38193821
fs.write(fd, Buffer.from(data, options.encoding), callback);
38203822
```

doc/api/http2.md

+1
Original file line numberDiff line numberDiff line change
@@ -2459,6 +2459,7 @@ The `CONNECT` method is used to allow an HTTP/2 server to be used as a proxy
24592459
for TCP/IP connections.
24602460

24612461
A simple TCP Server:
2462+
24622463
```js
24632464
const net = require('net');
24642465

doc/api/https.md

+1
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,7 @@ req.on('error', (e) => {
255255
});
256256
req.end();
257257
```
258+
258259
Example using options from [`tls.connect()`][]:
259260

260261
```js

0 commit comments

Comments
 (0)