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: add blanks around code fences #29366

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -665,16 +665,19 @@ during configuration if the ICU version is too old.
#### Unix/macOS

From an already-unpacked ICU:

```console
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
```

From a local ICU tarball:

```console
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
```

From a tarball URL:

```console
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
```
Expand Down
1 change: 1 addition & 0 deletions CPP_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ class FancyContainer {
...
}
```

## Memory Management

### Memory allocation
Expand Down
1 change: 1 addition & 0 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ generated output. The `command` string passed to the exec function is processed
directly by the shell and special characters (vary based on
[shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters))
need to be dealt with accordingly:

```js
exec('"/path/to/test file/test.sh" arg1 arg2');
// Double quotes are used so that the space in the path is not interpreted as
Expand Down
1 change: 1 addition & 0 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ added: v10.12.0
-->

Print source-able bash completion script for Node.js.

```console
$ node --completion-bash > node_bash_completion
$ source node_bash_completion
Expand Down
1 change: 1 addition & 0 deletions doc/api/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,7 @@ This method does not display anything unless used in the inspector. The
`console.profile()` method starts a JavaScript CPU profile with an optional
label until [`console.profileEnd()`][] is called. The profile is then added to
the **Profile** panel of the inspector.

```js
console.profile('MyLabel');
// Some code
Expand Down
1 change: 1 addition & 0 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -712,6 +712,7 @@ const dh = crypto.createDiffieHellmanGroup(name);
```

`name` is taken from [RFC 2412][] (modp1 and 2) and [RFC 3526][]:

```console
$ perl -ne 'print "$1\n" if /"(modp\d+)"/' src/node_crypto_groups.h
modp1 # 768 bits
Expand Down
1 change: 1 addition & 0 deletions doc/api/dgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,7 @@ socket.bind(1234, () => {

#### Example: IPv4 Outgoing Multicast Interface
All systems use an IP of the host on the desired physical interface:

```js
const socket = dgram.createSocket('udp4');

Expand Down
1 change: 1 addition & 0 deletions doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:
// Otherwise handle the data
});
```

- When an asynchronous method is called on an object that is an
[`EventEmitter`][], errors can be routed to that object's `'error'` event.

Expand Down
1 change: 1 addition & 0 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ module via `import`.
"main": "./src/index.js"
}
```

```js
// ./my-app.mjs

Expand Down
2 changes: 2 additions & 0 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,7 @@ fs.readFileSync(new URL('file:///p/a/t/h/%2f'));
/* TypeError [ERR_INVALID_FILE_URL_PATH]: File URL path must not include encoded
/ characters */
```

On Windows, `file:` URLs having encoded backslash will result in a throw:

```js
Expand Down Expand Up @@ -3816,6 +3817,7 @@ recommended.

When `file` is a file descriptor, the behavior is almost identical to directly
calling `fs.write()` like:

```javascript
fs.write(fd, Buffer.from(data, options.encoding), callback);
```
Expand Down
1 change: 1 addition & 0 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2459,6 +2459,7 @@ The `CONNECT` method is used to allow an HTTP/2 server to be used as a proxy
for TCP/IP connections.

A simple TCP Server:

```js
const net = require('net');

Expand Down
1 change: 1 addition & 0 deletions doc/api/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,7 @@ req.on('error', (e) => {
});
req.end();
```

Example using options from [`tls.connect()`][]:

```js
Expand Down
Loading