doc: fenced all code blocks, typo fixes

This changes the code blocks from 4-space indentation to ``` fences for better syntax highlighting and future linting support. Minor On-the-fly changes for typos and highlight breaking markdown have been made. JSON-Style objects have been changed so their closing bracket is on the same line as the opening one. Known issues: * Not every JSON / object notation has been improved. Should make another run for this. * Some example functions break hightlighting due to various combinations of brackets. However changing them means leaving the code style. Fixes: #4726 PR-URL: #4733 Reviewed-By: Roman Reiss <[email protected]>
nodejs · Feb 22, 2016 · 3105202 · 3105202
1 parent e760af7
commit 3105202
Show file tree

Hide file tree

Showing 36 changed files with 5,042 additions and 4,064 deletions.
diff --git a/doc/api/addons.markdown b/doc/api/addons.markdown
diff --git a/doc/api/assert.markdown b/doc/api/assert.markdown
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
diff --git a/doc/api/cluster.markdown b/doc/api/cluster.markdown
diff --git a/doc/api/console.markdown b/doc/api/console.markdown
@@ -15,33 +15,37 @@ The module exports two specific components:
 
 Example using the global `console`:
 
-    console.log('hello world');
-      // Prints: hello world, to stdout
-    console.log('hello %s', 'world');
-      // Prints: hello world, to stdout
-    console.error(new Error('Whoops, something bad happened'));
-      // Prints: [Error: Whoops, something bad happened], to stderr
-
-    const name = 'Will Robinson';
-    console.warn(`Danger ${name}! Danger!`);
-      // Prints: Danger Will Robinson! Danger!, to stderr
+```js
+console.log('hello world');
+  // Prints: hello world, to stdout
+console.log('hello %s', 'world');
+  // Prints: hello world, to stdout
+console.error(new Error('Whoops, something bad happened'));
+  // Prints: [Error: Whoops, something bad happened], to stderr
+
+const name = 'Will Robinson';
+console.warn(`Danger ${name}! Danger!`);
+  // Prints: Danger Will Robinson! Danger!, to stderr
+```
 
 Example using the `Console` class:
 
-    const out = getStreamSomehow();
-    const err = getStreamSomehow();
-    const myConsole = new console.Console(out, err);
+```js
+const out = getStreamSomehow();
+const err = getStreamSomehow();
+const myConsole = new console.Console(out, err);
 
-    myConsole.log('hello world');
-      // Prints: hello world, to out
-    myConsole.log('hello %s', 'world');
-      // Prints: hello world, to out
-    myConsole.error(new Error('Whoops, something bad happened'));
-      // Prints: [Error: Whoops, something bad happened], to err
+myConsole.log('hello world');
+  // Prints: hello world, to out
+myConsole.log('hello %s', 'world');
+  // Prints: hello world, to out
+myConsole.error(new Error('Whoops, something bad happened'));
+  // Prints: [Error: Whoops, something bad happened], to err
 
-    const name = 'Will Robinson';
-    myConsole.warn(`Danger ${name}! Danger!`);
-      // Prints: Danger Will Robinson! Danger!, to err
+const name = 'Will Robinson';
+myConsole.warn(`Danger ${name}! Danger!`);
+  // Prints: Danger Will Robinson! Danger!, to err
+```
 
 While the API for the `Console` class is designed fundamentally around the
 Web browser `console` object, the `Console` is Node.js is *not* intended to
@@ -55,7 +59,9 @@ when the destination is a pipe (to avoid blocking for long periods of time).
 
 In the following example, stdout is non-blocking while stderr is blocking:
 
-    $ node script.js 2> error.log | tee info.log
+```
+$ node script.js 2> error.log | tee info.log
+```
 
 Typically, the distinction between blocking/non-blocking is not important
 unless an application is logging significant amounts of data. High volume
@@ -69,8 +75,10 @@ The `Console` class can be used to create a simple logger with configurable
 output streams and can be accessed using either `require('console').Console`
 or `console.Console`:
 
-    const Console = require('console').Console;
-    const Console = console.Console;
+```js
+const Console = require('console').Console;
+const Console = console.Console;
+```
 
 ### new Console(stdout[, stderr])
 
@@ -79,30 +87,36 @@ Creates a new `Console` by passing one or two writable stream instances.
 is used for warning or error output. If `stderr` isn't passed, the warning
 and error output will be sent to the `stdout`.
 
-    const output = fs.createWriteStream('./stdout.log');
-    const errorOutput = fs.createWriteStream('./stderr.log');
-    // custom simple logger
-    const logger = new Console(output, errorOutput);
-    // use it like console
-    var count = 5;
-    logger.log('count: %d', count);
-    // in stdout.log: count 5
+```js
+const output = fs.createWriteStream('./stdout.log');
+const errorOutput = fs.createWriteStream('./stderr.log');
+// custom simple logger
+const logger = new Console(output, errorOutput);
+// use it like console
+var count = 5;
+logger.log('count: %d', count);
+// in stdout.log: count 5
+```
 
 The global `console` is a special `Console` whose output is sent to
 `process.stdout` and `process.stderr`. It is equivalent to calling:
 
-    new Console(process.stdout, process.stderr);
+```js
+new Console(process.stdout, process.stderr);
+```
 
 ### console.assert(value[, message][, ...])
 
 A simple assertion test that verifies whether `value` is truthy. If it is not,
 an `AssertionError` is throw. If provided, the error `message` is formatted
 using [`util.format()`][] and used as the error message.
 
-    console.assert(true, 'does nothing');
-      // OK
-    console.assert(false, 'Whoops %s', 'didn\'t work');
-      // AssertionError: Whoops didn't work
+```js
+console.assert(true, 'does nothing');
+  // OK
+console.assert(false, 'Whoops %s', 'didn\'t work');
+  // AssertionError: Whoops didn't work
+```
 
 ### console.dir(obj[, options])
 
@@ -129,11 +143,13 @@ used as the primary message and all additional used as substitution
 values similar to `printf()` (the arguments are all passed to
 [`util.format()`][]).
 
-    const code = 5;
-    console.error('error #%d', code);
-      // Prints: error #5, to stderr
-    console.error('error', code);
-      // Prints: error 5, to stderr
+```js
+const code = 5;
+console.error('error #%d', code);
+  // Prints: error #5, to stderr
+console.error('error', code);
+  // Prints: error 5, to stderr
+```
 
 If formatting elements (e.g. `%d`) are not found in the first string then
 [`util.inspect()`][] is called on each argument and the resulting string
@@ -150,11 +166,13 @@ used as the primary message and all additional used as substitution
 values similar to `printf()` (the arguments are all passed to
 [`util.format()`][]).
 
-    var count = 5;
-    console.log('count: %d', count);
-      // Prints: count: 5, to stdout
-    console.log('count: ', count);
-      // Prints: count: 5, to stdout
+```js
+var count = 5;
+console.log('count: %d', count);
+  // Prints: count: 5, to stdout
+console.log('count: ', count);
+  // Prints: count: 5, to stdout
+```
 
 If formatting elements (e.g. `%d`) are not found in the first string then
 [`util.inspect()`][] is called on each argument and the resulting string
@@ -173,31 +191,35 @@ timer's unique `label` as the parameter.
 Stops a timer that was previously started by calling [`console.time()`][] and
 prints the result to stdout:
 
-    console.time('100-elements');
-    for (var i = 0; i < 100; i++) {
-      ;
-    }
-    console.timeEnd('100-elements');
-    // prints 100-elements: 262ms
+```js
+console.time('100-elements');
+for (var i = 0; i < 100; i++) {
+  ;
+}
+console.timeEnd('100-elements');
+// prints 100-elements: 262ms
+```
 
 ### console.trace(message[, ...])
 
 Prints to stderr the string `'Trace :'`, followed by the [`util.format()`][]
 formatted message and stack trace to the current position in the code.
 
-    console.trace('Show me');
-      // Prints: (stack trace will vary based on where trace is called)
-      //  Trace: Show me
-      //    at repl:2:9
-      //    at REPLServer.defaultEval (repl.js:248:27)
-      //    at bound (domain.js:287:14)
-      //    at REPLServer.runBound [as eval] (domain.js:300:12)
-      //    at REPLServer.<anonymous> (repl.js:412:12)
-      //    at emitOne (events.js:82:20)
-      //    at REPLServer.emit (events.js:169:7)
-      //    at REPLServer.Interface._onLine (readline.js:210:10)
-      //    at REPLServer.Interface._line (readline.js:549:8)
-      //    at REPLServer.Interface._ttyWrite (readline.js:826:14)
+```js
+console.trace('Show me');
+  // Prints: (stack trace will vary based on where trace is called)
+  //  Trace: Show me
+  //    at repl:2:9
+  //    at REPLServer.defaultEval (repl.js:248:27)
+  //    at bound (domain.js:287:14)
+  //    at REPLServer.runBound [as eval] (domain.js:300:12)
+  //    at REPLServer.<anonymous> (repl.js:412:12)
+  //    at emitOne (events.js:82:20)
+  //    at REPLServer.emit (events.js:169:7)
+  //    at REPLServer.Interface._onLine (readline.js:210:10)
+  //    at REPLServer.Interface._line (readline.js:549:8)
+  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)
+```
 
 ### console.warn([data][, ...])