Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 102fb7d

Browse filesBrowse files
richardsun29Myles Borins
richardsun29
authored and
Myles Borins
committed
doc: remove "above" and "below" references
The docs were recently refactored, and some "above" and "below" references were no longer accurate. This commit removes many such references, and replaces others with links. PR-URL: #4499 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent df87176 commit 102fb7d
Copy full SHA for 102fb7d
Expand file treeCollapse file tree

13 files changed

+57
-45
lines changed
Open diff view settings
Collapse file

‎doc/api/child_process.markdown‎

Copy file name to clipboardExpand all lines: doc/api/child_process.markdown
+9-8Lines changed: 9 additions & 8 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@ function provides equivalent functionality in a synchronous manner that blocks
3333
the event loop until the spawned process either exits of is terminated.
3434

3535
For convenience, the `child_process` module provides a handful of synchronous
36-
and asynchronous alternatives to `child_process.spawn()` and
37-
`child_process.spawnSync()`, each of which are documented fully [below][].
38-
*Note that each of these alternatives are implemented on top of
39-
`child_process.spawn()` or `child_process.spawnSync()`.*
36+
and asynchronous alternatives to [`child_process.spawn()`][] and
37+
[`child_process.spawnSync()`][]. *Note that each of these alternatives are
38+
implemented on top of `child_process.spawn()` or `child_process.spawnSync()`.*
4039

4140
* `child_process.exec()`: spawns a shell and runs a command within that shell,
4241
passing the `stdout` and `stderr` to a callback function when complete.
@@ -222,7 +221,8 @@ spawned directly as a new process making it slightly more efficient than
222221
(Default: `process.execArgv`)
223222
* `silent` {Boolean} If true, stdin, stdout, and stderr of the child will be
224223
piped to the parent, otherwise they will be inherited from the parent, see
225-
the `'pipe'` and `'inherit'` options for [`spawn()`][]'s [`stdio`][] for more details
224+
the `'pipe'` and `'inherit'` options for [`spawn()`][]'s [`stdio`][] for
225+
more details
226226
(default is false)
227227
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
228228
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
@@ -262,10 +262,10 @@ not clone the current process.*
262262
* `cwd` {String} Current working directory of the child process
263263
* `env` {Object} Environment key-value pairs
264264
* `stdio` {Array|String} Child's stdio configuration. (See
265-
[below](#child_process_options_stdio))
265+
[`options.stdio`][])
266266
* `detached` {Boolean} Prepare child to run independently of its parent
267267
process. Specific behavior depends on the platform, see
268-
[below](#child_process_options_detached))
268+
[`options.detached`][])
269269
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
270270
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
271271
* return: {ChildProcess object}
@@ -933,6 +933,7 @@ to the same value.
933933
[`EventEmitters`]: events.html#events_class_events_eventemitter
934934
[`net.Server`]: net.html#net_class_net_server
935935
[`net.Socket`]: net.html#net_class_net_socket
936+
[`options.detached`]: #child_process_options_detached
937+
[`options.stdio`]: #child_process_options_stdio
936938
[`stdio`]: #child_process_options_stdio
937-
[below]: #child_process_asynchronous_process_creation
938939
[synchronous counterparts]: #child_process_synchronous_process_creation
Collapse file

‎doc/api/crypto.markdown‎

Copy file name to clipboardExpand all lines: doc/api/crypto.markdown
+2-1Lines changed: 2 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -972,7 +972,7 @@ supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in
972972
[RFC 2412][], but see [Caveats][]) and `'modp14'`, `'modp15'`,
973973
`'modp16'`, `'modp17'`, `'modp18'` (defined in [RFC 3526][]). The
974974
returned object mimics the interface of objects created by
975-
[`crypto.createDiffieHellman()`][] above, but will not allow changing
975+
[`crypto.createDiffieHellman()`][], but will not allow changing
976976
the keys (with [`diffieHellman.setPublicKey()`][] for example). The
977977
advantage of using this method is that the parties do not have to
978978
generate nor exchange a group modulus beforehand, saving both processor
@@ -1249,6 +1249,7 @@ See the reference for other recommendations and details.
12491249
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/apps/spkac.html
12501250
[`createCipher()`]: #crypto_crypto_createcipher_algorithm_password
12511251
[`createCipheriv()`]: #crypto_crypto_createcipheriv_algorithm_key_iv
1252+
[`createHash()`]: #crypto_crypto_createhash_algorithm
12521253
[`crypto.createDecipher`]: #crypto_crypto_createdecipher_algorithm_password
12531254
[`crypto.createDecipheriv`]: #crypto_crypto_createdecipheriv_algorithm_key_iv
12541255
[`crypto.createDiffieHellman()`]: #crypto_crypto_creatediffiehellman_prime_prime_encoding_generator_generator_encoding
Collapse file

‎doc/api/dns.markdown‎

Copy file name to clipboardExpand all lines: doc/api/dns.markdown
+5-4Lines changed: 5 additions & 4 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Alternatively, `options` can be an object containing these properties:
6969
`getaddrinfo` flags. If `hints` is not provided, then no flags are passed to
7070
`getaddrinfo`. Multiple flags can be passed through `hints` by logically
7171
`OR`ing their values.
72-
See [supported `getaddrinfo` flags][] below for more information on supported
72+
See [supported `getaddrinfo` flags][] for more information on supported
7373
flags.
7474
* `all`: {Boolean} - When `true`, the callback returns all resolved addresses
7575
in an array, otherwise returns a single address. Defaults to `false`.
@@ -151,10 +151,10 @@ Valid values for `rrtype` are:
151151
The `callback` function has arguments `(err, addresses)`. When successful,
152152
`addresses` will be an array. The type of each item in `addresses` is
153153
determined by the record type, and described in the documentation for the
154-
corresponding lookup methods below.
154+
corresponding lookup methods.
155155

156156
On error, `err` is an [`Error`][] object, where `err.code` is
157-
one of the error codes listed below.
157+
one of the error codes listed [here](#dns_error_codes).
158158

159159
## dns.resolve4(hostname, callback)
160160

@@ -250,7 +250,7 @@ The `callback` function has arguments `(err, hostnames)`, where `hostnames`
250250
is an array of resolved hostnames for the given `ip`.
251251

252252
On error, `err` is an [`Error`][] object, where `err.code` is
253-
one of the error codes listed below.
253+
one of the [DNS error codes][].
254254

255255
## dns.setServers(servers)
256256

@@ -335,6 +335,7 @@ processing that happens on libuv's threadpool that [`dns.lookup()`][] can have.
335335
They do not use the same set of configuration files than what [`dns.lookup()`][]
336336
uses. For instance, _they do not use the configuration from `/etc/hosts`_.
337337

338+
[DNS error codes]: #dns_error_codes
338339
[`dns.lookup()`]: #dns_dns_lookup_hostname_options_callback
339340
[`dns.resolve()`]: #dns_dns_resolve_hostname_rrtype_callback
340341
[`dns.resolve4()`]: #dns_dns_resolve4_hostname_callback
Collapse file

‎doc/api/errors.markdown‎

Copy file name to clipboardExpand all lines: doc/api/errors.markdown
+1-2Lines changed: 1 addition & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,7 @@ The number of frames captured by the stack trace is bounded by the smaller of
317317
loop tick.
318318

319319
System-level errors are generated as augmented `Error` instances, which are
320-
detailed [below](#errors_system_errors).
320+
detailed [here](#errors_system_errors).
321321

322322
## Class: RangeError
323323

@@ -503,7 +503,6 @@ found [here][online].
503503
[`process.on('uncaughtException')`]: process.html#process_event_uncaughtexception
504504
[`try / catch` construct]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
505505
[`try { } catch(err) { }`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
506-
[below]: #errors_error_propagation_and_interception
507506
[domains]: domain.html
508507
[event emitter-based]: events.html#events_class_events_eventemitter
509508
[file descriptors]: https://en.wikipedia.org/wiki/File_descriptor
Collapse file

‎doc/api/fs.markdown‎

Copy file name to clipboardExpand all lines: doc/api/fs.markdown
+3-2Lines changed: 3 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ Synchronous rmdir(2). Returns `undefined`.
659659
## fs.stat(path, callback)
660660

661661
Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
662-
`stats` is a [`fs.Stats`][] object. See the [`fs.Stats`][] section below for more
662+
`stats` is a [`fs.Stats`][] object. See the [`fs.Stats`][] section for more
663663
information.
664664

665665
## fs.statSync(path)
@@ -743,7 +743,7 @@ The supported boolean members are `persistent` and `recursive`. `persistent`
743743
indicates whether the process should continue to run as long as files are being
744744
watched. `recursive` indicates whether all subdirectories should be watched, or
745745
only the current directory. This applies when a directory is specified, and only
746-
on supported platforms (See Caveats below).
746+
on supported platforms (See [Caveats][]).
747747

748748
The default is `{ persistent: true, recursive: false }`.
749749

@@ -929,6 +929,7 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
929929

930930
[`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding
931931
[`Buffer`]: buffer.html#buffer_buffer
932+
[Caveats]: #fs_caveats
932933
[`fs.access()`]: #fs_fs_access_path_mode_callback
933934
[`fs.accessSync()`]: #fs_fs_accesssync_path_mode
934935
[`fs.appendFile()`]: fs.html#fs_fs_appendfile_file_data_options_callback
Collapse file

‎doc/api/http.markdown‎

Copy file name to clipboardExpand all lines: doc/api/http.markdown
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ require developers to manually close the HTTP clients using
5252
KeepAlive.
5353

5454
If you opt into using HTTP KeepAlive, you can create an Agent object
55-
with that flag set to `true`. (See the [constructor options][] below.)
55+
with that flag set to `true`. (See the [constructor options][].)
5656
Then, the Agent will keep unused sockets in a pool for later use. They
5757
will be explicitly marked so as to not keep the Node.js process running.
5858
However, it is still a good idea to explicitly [`destroy()`][] KeepAlive
Collapse file

‎doc/api/modules.markdown‎

Copy file name to clipboardExpand all lines: doc/api/modules.markdown
+3-3Lines changed: 3 additions & 3 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ may itself have dependencies, and in some cases, these dependencies may even
9494
collide or form cycles.
9595

9696
Since Node.js looks up the `realpath` of any modules it loads (that is,
97-
resolves symlinks), and then looks for their dependencies in the
98-
`node_modules` folders as described above, this situation is very simple to
99-
resolve with the following architecture:
97+
resolves symlinks), and then looks for their dependencies in the `node_modules`
98+
folders as described [here](#modules_loading_from_node_modules_folders), this
99+
situation is very simple to resolve with the following architecture:
100100

101101
* `/usr/lib/node/foo/1.2.3/` - Contents of the `foo` package, version 1.2.3.
102102
* `/usr/lib/node/bar/4.3.2/` - Contents of the `bar` package that `foo`
Collapse file

‎doc/api/path.markdown‎

Copy file name to clipboardExpand all lines: doc/api/path.markdown
+3-1Lines changed: 3 additions & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ an empty string. Examples:
8383

8484
## path.format(pathObject)
8585

86-
Returns a path string from an object, the opposite of `path.parse` above.
86+
Returns a path string from an object, the opposite of [`path.parse`][].
8787

8888
path.format({
8989
root : "/",
@@ -276,3 +276,5 @@ An example on Windows:
276276

277277
Provide access to aforementioned `path` methods but always interact in a win32
278278
compatible way.
279+
280+
[`path.parse`]: #path_path_parse_pathstring
Collapse file

‎doc/api/process.markdown‎

Copy file name to clipboardExpand all lines: doc/api/process.markdown
+2-2Lines changed: 2 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -165,8 +165,7 @@ In cases like this, you may not want to track the rejection as a developer
165165
error like you would for other `'unhandledRejection'` events. To address
166166
this, you can either attach a dummy `.catch(function() { })` handler to
167167
`resource.loaded`, preventing the `'unhandledRejection'` event from being
168-
emitted, or you can use the `'rejectionHandled'` event. Below is an
169-
explanation of how to do that.
168+
emitted, or you can use the [`'rejectionHandled'`][] event.
170169

171170
## Exit Codes
172171

@@ -953,6 +952,7 @@ Will print something like:
953952
[`net.Socket`]: net.html#net_class_net_socket
954953
[`process.exit()`]: #process_process_exit_code
955954
[`promise.catch(...)`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
955+
[`'rejectionHandled'`]: #process_event_rejectionhandled
956956
[`require.main`]: modules.html#modules_accessing_the_main_module
957957
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_arg
958958
[Signal Events]: #process_signal_events
Collapse file

‎doc/api/repl.markdown‎

Copy file name to clipboardExpand all lines: doc/api/repl.markdown
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Previously in Node.js/io.js v2.x, REPL history was controlled by using a
5959
format. This variable has now been deprecated, and your REPL history will
6060
automatically be converted to using plain text. The new file will be saved to
6161
either your home directory, or a directory defined by the `NODE_REPL_HISTORY`
62-
variable, as documented below.
62+
variable, as documented [here](#repl_environment_variable_options).
6363

6464
## REPL Features
6565

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.