Skip to content

Commit

Permalink
doc: disable no-undefined-references workarounds
Browse files Browse the repository at this point in the history
The manual links appear to be specific workarounds, so just ignore them

PR-URL: #35647
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
nschonni authored and targos committed Nov 3, 2020
1 parent eb55462 commit 59b36af
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/api/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -599,10 +599,12 @@ be an array of objects with the following properties:
added: v0.1.27
-->

<!--lint disable no-undefined-references-->
* `hostname` {string}
* `callback` {Function}
* `err` {Error}
* `records` <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type">&lt;string[][]&gt;</a>
<!--lint enable no-undefined-references-->

Uses the DNS protocol to resolve text queries (`TXT` records) for the
`hostname`. The `records` argument passed to the `callback` function is a
Expand Down
4 changes: 4 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,13 +258,15 @@ an [IPC][] server depending on what it listens to.

Possible signatures:

<!--lint disable no-undefined-references-->
* [`server.listen(handle[, backlog][, callback])`][`server.listen(handle)`]
* [`server.listen(options[, callback])`][`server.listen(options)`]
* [`server.listen(path[, backlog][, callback])`][`server.listen(path)`]
for [IPC][] servers
* <a href="#net_server_listen_port_host_backlog_callback">
<code>server.listen([port[, host[, backlog]]][, callback])</code></a>
for TCP servers
<!--lint enable no-undefined-references-->

This function is asynchronous. When the server starts listening, the
[`'listening'`][] event will be emitted. The last parameter `callback`
Expand Down Expand Up @@ -346,12 +348,14 @@ changes:
functions.
* Returns: {net.Server}

<!--lint disable no-undefined-references-->
If `port` is specified, it behaves the same as
<a href="#net_server_listen_port_host_backlog_callback">
<code>server.listen([port[, host[, backlog]]][, callback])</code></a>.
Otherwise, if `path` is specified, it behaves the same as
[`server.listen(path[, backlog][, callback])`][`server.listen(path)`].
If none of them is specified, an error will be thrown.
<!--lint enable no-undefined-references-->

If `exclusive` is `false` (default), then cluster workers will use the same
underlying handle, allowing connection handling duties to be shared. When
Expand Down

0 comments on commit 59b36af

Please sign in to comment.