Skip to content

Commit

Permalink
doc: prepare js code for eslint-plugin-markdown
Browse files Browse the repository at this point in the history
This is an initial step to eliminate most of parsing errors.

PR-URL: #12563
Refs: #12557 (comment)
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
  • Loading branch information
vsemozhetbyt authored and evanlucas committed May 2, 2017
1 parent cbdf9a9 commit 313b205
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 36 deletions.
10 changes: 6 additions & 4 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,9 @@ bat.stderr.on('data', (data) => {
bat.on('exit', (code) => {
console.log(`Child exited with code ${code}`);
});
```

```js
// OR...
const exec = require('child_process').exec;
exec('my.bat', (err, stdout, stderr) => {
Expand Down Expand Up @@ -184,14 +186,14 @@ The `options` argument may be passed as the second argument to customize how
the process is spawned. The default options are:

```js
{
const defaults = {
encoding: 'utf8',
timeout: 0,
maxBuffer: 200*1024,
killSignal: 'SIGTERM',
cwd: null,
env: null
}
};
```

If `timeout` is greater than `0`, the parent will send the signal
Expand Down Expand Up @@ -348,10 +350,10 @@ trigger arbitrary command execution.**
A third argument may be used to specify additional options, with these defaults:

```js
{
const defaults = {
cwd: undefined,
env: process.env
}
};
```

Use `cwd` to specify the working directory from which the process is spawned.
Expand Down
3 changes: 3 additions & 0 deletions doc/api/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ or `console.Console`:

```js
const Console = require('console').Console;
```

```js
const Console = console.Console;
```

Expand Down
10 changes: 5 additions & 5 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ synchronous counterparts are of this type.
For a regular file [`util.inspect(stats)`][] would return a string very
similar to this:

```js
```txt
Stats {
dev: 2114,
ino: 48064969,
Expand Down Expand Up @@ -630,13 +630,13 @@ default value of 64 kb for the same parameter.
`options` is an object or string with the following defaults:

```js
{
const defaults = {
flags: 'r',
encoding: null,
fd: null,
mode: 0o666,
autoClose: true
}
};
```

`options` can include `start` and `end` values to read a range of bytes from
Expand Down Expand Up @@ -696,13 +696,13 @@ Returns a new [`WriteStream`][] object. (See [Writable Stream][]).
`options` is an object or string with the following defaults:

```js
{
const defaults = {
flags: 'w',
defaultEncoding: 'utf8',
fd: null,
mode: 0o666,
autoClose: true
}
};
```

`options` may also include a `start` option to allow writing data at
Expand Down
3 changes: 2 additions & 1 deletion doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -558,7 +558,8 @@ object, it is common to also reassign `exports`, for example:

```js
module.exports = exports = function Constructor() {
// ... etc.
// ... etc.
};
```

To illustrate the behavior, imagine this hypothetical implementation of
Expand Down
4 changes: 2 additions & 2 deletions doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@ running the `./configure` script.

An example of the possible output looks like:

```js
```txt
{
target_defaults:
{ cflags: [],
Expand Down Expand Up @@ -1695,7 +1695,7 @@ to load modules that were compiled against a different module ABI version.
console.log(process.versions);
```

Will generate output similar to:
Will generate an object similar to:

```js
{
Expand Down
2 changes: 1 addition & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1224,7 +1224,7 @@ stream.
`tls.TLSSocket()`. For example, the code:

```js
pair = tls.createSecurePair( ... );
pair = tls.createSecurePair(/* ... */);
pair.encrypted.pipe(socket);
socket.pipe(pair.encrypted);
```
Expand Down
4 changes: 3 additions & 1 deletion doc/api/zlib.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,9 @@ request.on('response', (response) => {
break;
}
});
```

```js
// server example
// Running a gzip operation on every request is quite expensive.
// It would be much more efficient to cache the compressed buffer.
Expand Down Expand Up @@ -159,7 +161,7 @@ For example, to reduce the default memory requirements from 256K to 128K, the
options should be set to:

```js
{ windowBits: 14, memLevel: 7 }
const options = { windowBits: 14, memLevel: 7 };
```

This will, however, generally degrade compression.
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/using-internal-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ and appending the new error codes to the end using the utility `E()` method.

```js
E('EXAMPLE_KEY1', 'This is the error value');
E('EXAMPLE_KEY2', (a, b) => return `${a} ${b}`);
E('EXAMPLE_KEY2', (a, b) => `${a} ${b}`);
```

The first argument passed to `E()` is the static identifier. The second
Expand Down
42 changes: 21 additions & 21 deletions doc/guides/writing-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,27 +23,27 @@ Add tests when:
Let's analyze this basic test from the Node.js test suite:

```javascript
1 'use strict';
2 const common = require('../common');
3
4 // This test ensures that the http-parser can handle UTF-8 characters
5 // in the http header.
6
7 const assert = require('assert');
8 const http = require('http');
9
10 const server = http.createServer(common.mustCall((req, res) => {
11 res.end('ok');
12 }));
13 server.listen(0, () => {
14 http.get({
15 port: server.address().port,
16 headers: {'Test': 'Düsseldorf'}
17 }, common.mustCall((res) => {
18 assert.strictEqual(res.statusCode, 200);
19 server.close();
20 }));
21 });
'use strict'; // 1
const common = require('../common'); // 2
// 3
// This test ensures that the http-parser can handle UTF-8 characters // 4
// in the http header. // 5
// 6
const assert = require('assert'); // 7
const http = require('http'); // 8
// 9
const server = http.createServer(common.mustCall((req, res) => { // 10
res.end('ok'); // 11
})); // 12
server.listen(0, () => { // 13
http.get({ // 14
port: server.address().port, // 15
headers: {'Test': 'Düsseldorf'} // 16
}, common.mustCall((res) => { // 17
assert.strictEqual(res.statusCode, 200); // 18
server.close(); // 19
})); // 20
}); // 21
```

### **Lines 1-2**
Expand Down

0 comments on commit 313b205

Please sign in to comment.