Skip to content

Commit 8a17a25

Browse files
vsemozhetbytMylesBorins
authored andcommitted
doc: fix some nits in hardcoded manpage links
After #20785, we wrap autogenerated manpage links in code elements. This PR unify some hardcoded manpage links with autogenerated ones: it adds backticks, parentheses, section numbers, and updates URLs. Also, some typos are fixes in passing (missing periods, reference sorting). PR-URL: #20854 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 3110d15 commit 8a17a25

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

doc/api/errors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1704,6 +1704,7 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
17041704
[`--force-fips`]: cli.html#cli_force_fips
17051705
[`child_process`]: child_process.html
17061706
[`cipher.getAuthTag()`]: crypto.html#crypto_cipher_getauthtag
1707+
[`Class: assert.AssertionError`]: assert.html#assert_class_assert_assertionerror
17071708
[`crypto.timingSafeEqual()`]: crypto.html#crypto_crypto_timingsafeequal_a_b
17081709
[`dgram.createSocket()`]: dgram.html#dgram_dgram_createsocket_options_callback
17091710
[`ERR_INVALID_ARG_TYPE`]: #ERR_INVALID_ARG_TYPE
@@ -1736,7 +1737,7 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
17361737
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
17371738
[`require('crypto').setEngine()`]: crypto.html#crypto_crypto_setengine_engine_flags
17381739
[`server.listen()`]: net.html#net_server_listen
1739-
[`Class: assert.AssertionError`]: assert.html#assert_class_assert_assertionerror
1740+
[`zlib`]: zlib.html
17401741
[ES6 module]: esm.html
17411742
[Node.js Error Codes]: #nodejs-error-codes
17421743
[V8's stack trace API]: https://github.com/v8/v8/wiki/Stack-Trace-API
@@ -1748,8 +1749,7 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
17481749
[ICU]: intl.html#intl_internationalization_support
17491750
[online]: http://man7.org/linux/man-pages/man3/errno.3.html
17501751
[stream-based]: stream.html
1751-
[syscall]: http://man7.org/linux/man-pages/man2/syscall.2.html
1752+
[syscall]: http://man7.org/linux/man-pages/man2/syscalls.2.html
17521753
[try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
17531754
[vm]: vm.html
17541755
[WHATWG Supported Encodings]: util.html#util_whatwg_supported_encodings
1755-
[`zlib`]: zlib.html

doc/api/fs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3036,9 +3036,9 @@ The recursive option is only supported on macOS and Windows.
30363036
This feature depends on the underlying operating system providing a way
30373037
to be notified of filesystem changes.
30383038

3039-
* On Linux systems, this uses [`inotify`]
3040-
* On BSD systems, this uses [`kqueue`]
3041-
* On macOS, this uses [`kqueue`] for files and [`FSEvents`] for directories.
3039+
* On Linux systems, this uses [`inotify(7)`].
3040+
* On BSD systems, this uses [`kqueue(2)`].
3041+
* On macOS, this uses [`kqueue(2)`] for files and [`FSEvents`] for directories.
30423042
* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`].
30433043
* On Windows systems, this feature depends on [`ReadDirectoryChangesW`].
30443044
* On Aix systems, this feature depends on [`AHAFS`], which must be enabled.
@@ -4680,8 +4680,8 @@ the file contents.
46804680
[`fs.watch()`]: #fs_fs_watch_filename_options_listener
46814681
[`fs.write()`]: #fs_fs_write_fd_buffer_offset_length_position_callback
46824682
[`fs.writeFile()`]: #fs_fs_writefile_file_data_options_callback
4683-
[`inotify`]: http://man7.org/linux/man-pages/man7/inotify.7.html
4684-
[`kqueue`]: https://www.freebsd.org/cgi/man.cgi?kqueue
4683+
[`inotify(7)`]: http://man7.org/linux/man-pages/man7/inotify.7.html
4684+
[`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2
46854685
[`net.Socket`]: net.html#net_class_net_socket
46864686
[`stat()`]: fs.html#fs_fs_stat_path_callback
46874687
[`util.promisify()`]: util.html#util_util_promisify_original

doc/api/net.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,8 @@ length of the queue of pending connections. The actual length will be determined
204204
by the OS through sysctl settings such as `tcp_max_syn_backlog` and `somaxconn`
205205
on Linux. The default value of this parameter is 511 (not 512).
206206

207-
All [`net.Socket`][] are set to `SO_REUSEADDR` (See [socket(7)][] for details).
207+
All [`net.Socket`][] are set to `SO_REUSEADDR` (see [`socket(7)`][] for
208+
details).
208209

209210
The `server.listen()` method can be called again if and only if there was an
210211
error during the first `server.listen()` call or `server.close()` has been
@@ -1135,6 +1136,7 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
11351136
[`server.listen(handle)`]: #net_server_listen_handle_backlog_callback
11361137
[`server.listen(options)`]: #net_server_listen_options_callback
11371138
[`server.listen(path)`]: #net_server_listen_path_backlog_callback
1139+
[`socket(7)`]: http://man7.org/linux/man-pages/man7/socket.7.html
11381140
[`socket.connect()`]: #net_socket_connect
11391141
[`socket.connect(options)`]: #net_socket_connect_options_connectlistener
11401142
[`socket.connect(path)`]: #net_socket_connect_path_connectlistener
@@ -1152,7 +1154,6 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
11521154
[Readable Stream]: stream.html#stream_class_stream_readable
11531155
[duplex stream]: stream.html#stream_class_stream_duplex
11541156
[half-closed]: https://tools.ietf.org/html/rfc1122
1155-
[socket(7)]: http://man7.org/linux/man-pages/man7/socket.7.html
11561157
[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback
11571158
[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0
11581159
[unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address

0 commit comments

Comments
 (0)