Skip to content

[v8.x backport] doc: fix various nits #19753

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

Closed
vsemozhetbyt wants to merge 5 commits into from
Closed

[v8.x backport] doc: fix various nits #19753

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2be7b2b
doc: fix various nits
vsemozhetbyt Apr 2, 2018
8881748
fixup: space infix operators
vsemozhetbyt Apr 2, 2018
687e0e4
fixup: unify quotes in inline code spans
vsemozhetbyt Apr 2, 2018
807d714
fixup: unify `* Returns:`
vsemozhetbyt Apr 2, 2018
b4e97bd
fixup: dedupe spaces
vsemozhetbyt Apr 2, 2018
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
Prev Previous commit
Next Next commit
fixup: space infix operators
  • Loading branch information
@vsemozhetbyt
vsemozhetbyt committed Apr 4, 2018
commit 8881748a4a5f2f9c9eaa5d4157fc3b6f39f94886
20 changes: 10 additions & 10 deletions doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ changes:
[Shell Requirements][] and [Default Windows Shell][].
* `timeout` {number} **Default:** `0`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. **Default:** `200*1024`. If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
stderr. **Default:** `200 * 1024`. If exceeded, the child process is
terminated. See caveat at [`maxBuffer` and Unicode][].
* `killSignal` {string|integer} **Default:** `'SIGTERM'`
* `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)).
Expand Down Expand Up @@ -257,8 +257,8 @@ changes:
* `encoding` {string} **Default:** `'utf8'`
* `timeout` {number} **Default:** `0`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. **Default:** `200*1024` If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
stderr. **Default:** `200 * 1024` If exceeded, the child process is
terminated. See caveat at [`maxBuffer` and Unicode][].
* `killSignal` {string|integer} **Default:** `'SIGTERM'`
* `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)).
Expand Down Expand Up @@ -706,8 +706,8 @@ changes:
* `killSignal` {string|integer} The signal value to be used when the spawned
process will be killed. **Default:** `'SIGTERM'`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. **Default:** `200*1024` If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
stderr. **Default:** `200 * 1024` If exceeded, the child process is
terminated. See caveat at [`maxBuffer` and Unicode][].
* `encoding` {string} The encoding used for all stdio inputs and outputs. **Default:** `'buffer'`
* `windowsHide` {boolean} Hide the subprocess console window that would
normally be created on Windows systems. **Default:** `false`.
Expand Down Expand Up @@ -767,8 +767,8 @@ changes:
* `killSignal` {string|integer} The signal value to be used when the spawned
process will be killed. **Default:** `'SIGTERM'`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. **Default:** `200*1024` If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
stderr. **Default:** `200 * 1024` If exceeded, the child process is
terminated. See caveat at [`maxBuffer` and Unicode][].
* `encoding` {string} The encoding used for all stdio inputs and outputs.
**Default:** `'buffer'`
* `windowsHide` {boolean} Hide the subprocess console window that would
Expand Down Expand Up @@ -825,8 +825,8 @@ changes:
* `killSignal` {string|integer} The signal value to be used when the spawned
process will be killed. **Default:** `'SIGTERM'`
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. **Default:** `200*1024` If exceeded, the child process is terminated.
See caveat at [`maxBuffer` and Unicode][].
stderr. **Default:** `200 * 1024` If exceeded, the child process is
terminated. See caveat at [`maxBuffer` and Unicode][].
* `encoding` {string} The encoding used for all stdio inputs and outputs.
**Default:** `'buffer'`
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
Expand Down
2 changes: 1 addition & 1 deletion doc/api/debugger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2+2
> 2 + 2
4
debug> next
< world
Expand Down
4 changes: 2 additions & 2 deletions doc/api/modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ console.log('b done');
console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);
console.log('in main, a.done = %j, b.done = %j', a.done, b.done);
```

When `main.js` loads `a.js`, then `a.js` in turn loads `b.js`. At that
Expand All @@ -296,7 +296,7 @@ in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true
in main, a.done = true, b.done = true
```

Careful planning is required to allow cyclic module dependencies to work
Expand Down
4 changes: 2 additions & 2 deletions doc/api/zlib.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ The memory requirements for deflate are (in bytes):
(1 << (windowBits + 2)) + (1 << (memLevel + 9))
```

That is: 128K for windowBits=15 + 128K for memLevel = 8
That is: 128K for windowBits = 15 + 128K for memLevel = 8
(default values) plus a few kilobytes for small objects.

For example, to reduce the default memory requirements from 256K to 128K, the
Expand All @@ -178,7 +178,7 @@ const options = { windowBits: 14, memLevel: 7 };
This will, however, generally degrade compression.

The memory requirements for inflate are (in bytes) `1 << windowBits`.
That is, 32K for windowBits=15 (default value) plus a few kilobytes
That is, 32K for windowBits = 15 (default value) plus a few kilobytes
for small objects.

This is in addition to a single internal output slab buffer of size
Expand Down