doc: fix relative links in net docs #5358
Conversation
They were not being processed as relative links.
|
/cc @nodejs/documentation |
|
LGTM. Looks like this was in the tree for quite some time. Did we switch the Markdown parser recently, or why is this being noticed now? |
| @@ -723,8 +723,8 @@ Returns true if input is a version 6 IP address, otherwise returns false. | |||
| [`pause()`]: #net_socket_pause | |||
| [`resume()`]: #net_socket_resume | |||
| [`server.getConnections()`]: #net_server_getconnections_callback | |||
| [`server.listen(port, \[host\], \[backlog\], \[callback\])`]: #net_server_listen_port_hostname_backlog_callback | |||
| [`socket.connect(options\[, connectListener\])`]: #net_socket_connect_options_connectlistener | |||
| [`server.listen(port, host, backlog, callback)`]: #net_server_listen_port_hostname_backlog_callback | |||
There was a problem hiding this comment.
Can't this be simply server.listen?
There was a problem hiding this comment.
I don't think so, the link signature of these methods include the arguments. How are these generated, by the way?
There was a problem hiding this comment.
@silverwind You mean, this tag could have been auto-generated with a tool?
There was a problem hiding this comment.
I don't think they are generated
There was a problem hiding this comment.
The <a id>'s which these link to are certainly autogenerated from the doctool:
<h3>
server.listen(port[, hostname][, backlog][, callback])
<span>
<a class="mark" href="#net_server_listen_port_hostname_backlog_callback" id="net_server_listen_port_hostname_backlog_callback">#
</a>
</span>
</h3>They long ids are necessary to link to different method signatures, and there can only be one id per element in HTML, so I think your suggestion is not possible.
There was a problem hiding this comment.
Oh, and I just notice that I misread your suggestion completely, please disregard me :)
|
Ping @evanlucas, I'd also be in favor of shortening these link names to just |
|
Yea, the reason I didn't do that is because there are multiple |
|
Alright, landed in 1c30d60. |
They were not being processed as relative links. PR-URL: #5358 Reviewed-By: Roman Reiss <me@silverwind.io>
They were not being processed as relative links. PR-URL: #5358 Reviewed-By: Roman Reiss <me@silverwind.io>
|
Added the lts watch label... |
|
Great stuff guys/gals |
They were not being processed as relative links. PR-URL: #5358 Reviewed-By: Roman Reiss <me@silverwind.io>
They were not being processed as relative links. PR-URL: #5358 Reviewed-By: Roman Reiss <me@silverwind.io>
They were not being processed as relative links. Marked apparently does not like square brackets inside of relative links.