summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaijiro Wachi <daijiro.wachi@gmail.com>2017-10-22 17:51:14 +0200
committerDaijiro Wachi <daijiro.wachi@gmail.com>2017-10-24 18:04:18 +0200
commit986be03a4c349dcac7a5fa4c85d81a25af50f02f (patch)
tree052f3031089faa72f3fed9675909568cbd0525f1 /doc
parent7671f253f2e5aff3ac19843a9dec8817fb1188a8 (diff)
downloadandroid-node-v8-986be03a4c349dcac7a5fa4c85d81a25af50f02f.tar.gz
android-node-v8-986be03a4c349dcac7a5fa4c85d81a25af50f02f.tar.bz2
android-node-v8-986be03a4c349dcac7a5fa4c85d81a25af50f02f.zip
doc: fix doc styles
CONTRIBUTING.md + L857: Unused definition + L861: Unused definition + L863: Unused definition doc/api/assert.md + L719: Unused definition doc/api/async_hooks.md + L460: Missing code-language flag doc/api/child_process.md + L1362: Unused definition doc/api/dns.md + L674: Unused definition doc/api/esm.md + L178: Missing code-language flag doc/api/http.md + L1868: Unused definition + L1887: Unused definition + L1888: Unused definition + L1889: Unused definition + L1916: Unused definition + L1917: Unused definition doc/api/https.md + L260: Unused definition doc/api/os.md + L1226: Unused definition doc/api/process.md + L1888: Unused definition doc/api/stream.md + L2227: Definitions with the same identifier doc/guides/writing-and-running-benchmarks.md + L1: Missing newline character at end of file Refs: https://github.com/nodejs/node/pull/12756 PR-URL: https://github.com/nodejs/node/pull/16385 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/assert.md1
-rw-r--r--doc/api/async_hooks.md2
-rw-r--r--doc/api/child_process.md1
-rw-r--r--doc/api/dns.md1
-rw-r--r--doc/api/esm.md2
-rw-r--r--doc/api/http.md6
-rw-r--r--doc/api/https.md1
-rw-r--r--doc/api/os.md1
-rw-r--r--doc/api/process.md1
-rw-r--r--doc/api/stream.md1
-rw-r--r--doc/guides/writing-and-running-benchmarks.md2
11 files changed, 3 insertions, 16 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index d22fb3eac2..6179caa27f 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -716,7 +716,6 @@ assert(Object.is(str1 / 1, str2 / 1));
For more information, see
[MDN's guide on equality comparisons and sameness][mdn-equality-guide].
-[`Error`]: errors.html#errors_class_error
[`Error.captureStackTrace`]: errors.html#errors_error_capturestacktrace_targetobject_constructoropt
[`Map`]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Map
[`Object.is()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
index 67e7198034..3c2096e9cc 100644
--- a/doc/api/async_hooks.md
+++ b/doc/api/async_hooks.md
@@ -457,7 +457,7 @@ new Promise((resolve) => resolve(true)).then((a) => {});
calls the following callbacks:
-```
+```text
init for PROMISE with id 5, trigger id: 1
promise resolve 5 # corresponds to resolve(true)
init for PROMISE with id 6, trigger id: 5 # the Promise returned by then()
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
index a3c380d571..413949c287 100644
--- a/doc/api/child_process.md
+++ b/doc/api/child_process.md
@@ -1359,7 +1359,6 @@ unavailable.
[`Error`]: errors.html#errors_class_error
[`EventEmitter`]: events.html#events_class_eventemitter
[`JSON.stringify` spec]: https://tc39.github.io/ecma262/#sec-json.stringify
-[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[`subprocess.connected`]: #child_process_subprocess_connected
[`subprocess.disconnect()`]: #child_process_subprocess_disconnect
[`subprocess.kill()`]: #child_process_subprocess_kill_signal
diff --git a/doc/api/dns.md b/doc/api/dns.md
index d564aea424..56f2d0660c 100644
--- a/doc/api/dns.md
+++ b/doc/api/dns.md
@@ -671,4 +671,3 @@ uses. For instance, _they do not use the configuration from `/etc/hosts`_.
[Implementation considerations section]: #dns_implementation_considerations
[rfc5952]: https://tools.ietf.org/html/rfc5952#section-6
[supported `getaddrinfo` flags]: #dns_supported_getaddrinfo_flags
-[the official libuv documentation]: http://docs.libuv.org/en/latest/threadpool.html
diff --git a/doc/api/esm.md b/doc/api/esm.md
index bc25c88b9a..76592927db 100644
--- a/doc/api/esm.md
+++ b/doc/api/esm.md
@@ -175,7 +175,7 @@ export function resolve(specifier, parentModuleURL/*, defaultResolve */) {
With this loader, running:
-```
+```console
NODE_OPTIONS='--experimental-modules --loader ./custom-loader.mjs' node x.js
```
diff --git a/doc/api/http.md b/doc/api/http.md
index 4a84e50ba0..f121fed76c 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -1868,7 +1868,6 @@ const req = http.request(options, (res) => {
```
[`'checkContinue'`]: #http_event_checkcontinue
-[`'listening'`]: net.html#net_event_listening
[`'request'`]: #http_event_request
[`'response'`]: #http_event_response
[`Agent`]: #http_class_http_agent
@@ -1888,9 +1887,6 @@ const req = http.request(options, (res) => {
[`http.request()`]: #http_http_request_options_callback
[`message.headers`]: #http_message_headers
[`net.Server.close()`]: net.html#net_server_close_callback
-[`net.Server.listen()`]: net.html#net_server_listen_handle_backlog_callback
-[`net.Server.listen(path)`]: net.html#net_server_listen_path_backlog_callback
-[`net.Server.listen(port)`]: net.html#net_server_listen_port_host_backlog_callback
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener
@@ -1917,5 +1913,3 @@ const req = http.request(options, (res) => {
[Readable Stream]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable
[socket.unref()]: net.html#net_socket_unref
-[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0
-[unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address
diff --git a/doc/api/https.md b/doc/api/https.md
index e8db7d16b3..4740986170 100644
--- a/doc/api/https.md
+++ b/doc/api/https.md
@@ -257,7 +257,6 @@ const req = https.request(options, (res) => {
[`http.Server`]: http.html#http_class_http_server
[`http.close()`]: http.html#http_server_close_callback
[`http.get()`]: http.html#http_http_get_options_callback
-[`http.listen()`]: http.html#http_server_listen_port_hostname_backlog_callback
[`http.request()`]: http.html#http_http_request_options_callback
[`https.Agent`]: #https_class_https_agent
[`https.request()`]: #https_https_request_options_callback
diff --git a/doc/api/os.md b/doc/api/os.md
index 69852bf810..019330cdf9 100644
--- a/doc/api/os.md
+++ b/doc/api/os.md
@@ -1223,5 +1223,4 @@ information.
[`process.arch`]: process.html#process_process_arch
[`process.platform`]: process.html#process_process_platform
-[OS Constants]: #os_os_constants
[uname(3)]: https://linux.die.net/man/3/uname
diff --git a/doc/api/process.md b/doc/api/process.md
index 3b9d0aeca2..4776cd9ee1 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1885,7 +1885,6 @@ cases:
[`Error`]: errors.html#errors_class_error
[`EventEmitter`]: events.html#events_class_eventemitter
[`JSON.stringify` spec]: https://tc39.github.io/ecma262/#sec-json.stringify
-[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[`console.error()`]: console.html#console_console_error_data_args
[`console.log()`]: console.html#console_console_log_data_args
[`end()`]: stream.html#stream_writable_end_chunk_encoding_callback
diff --git a/doc/api/stream.md b/doc/api/stream.md
index d2af5cd933..96f67d75b3 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -2224,7 +2224,6 @@ contain multi-byte characters.
[http-incoming-message]: http.html#http_class_http_incomingmessage
[zlib]: zlib.html
[hwm-gotcha]: #stream_highwatermark_discrepency_after_calling_readable_setencoding
-[Readable]: #stream_class_stream_readable
[stream-_flush]: #stream_transform_flush_callback
[stream-_read]: #stream_readable_read_size_1
[stream-_transform]: #stream_transform_transform_chunk_encoding_callback
diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md
index 880340ba93..1350b90e02 100644
--- a/doc/guides/writing-and-running-benchmarks.md
+++ b/doc/guides/writing-and-running-benchmarks.md
@@ -438,4 +438,4 @@ Supported options keys are:
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances
[git-for-windows]: http://git-scm.com/download/win
[nghttp2.org]: http://nghttp2.org
-[benchmark-ci]: https://github.com/nodejs/benchmarking/blob/master/docs/core_benchmarks.md \ No newline at end of file
+[benchmark-ci]: https://github.com/nodejs/benchmarking/blob/master/docs/core_benchmarks.md