Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix relative links in net docs #5358

Closed
wants to merge 1 commit into from

Conversation

evanlucas
Copy link
Contributor

They were not being processed as relative links. Marked apparently does not like square brackets inside of relative links.

screen shot 2016-02-22 at 1 29 31 am

They were not being processed as relative links.
@evanlucas evanlucas added the doc Issues and PRs related to the documentations. label Feb 22, 2016
@mscdex mscdex added the net Issues and PRs related to the net subsystem. label Feb 22, 2016
@evanlucas
Copy link
Contributor Author

/cc @nodejs/documentation

@silverwind
Copy link
Contributor

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't this be simply server.listen?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, the link signature of these methods include the arguments. How are these generated, by the way?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@silverwind You mean, this tag could have been auto-generated with a tool?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think they are generated

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, and I just notice that I misread your suggestion completely, please disregard me :)

@silverwind
Copy link
Contributor

Ping @evanlucas, I'd also be in favor of shortening these link names to just server.listen.

@evanlucas
Copy link
Contributor Author

Yea, the reason I didn't do that is because there are multiple server.listen headings. That is why the arguments are included in the link

@silverwind
Copy link
Contributor

Alright, landed in 1c30d60.

@silverwind silverwind closed this Feb 27, 2016
silverwind pushed a commit that referenced this pull request Feb 27, 2016
They were not being processed as relative links.

PR-URL: #5358
Reviewed-By: Roman Reiss <[email protected]>
rvagg pushed a commit that referenced this pull request Feb 28, 2016
They were not being processed as relative links.

PR-URL: #5358
Reviewed-By: Roman Reiss <[email protected]>
@Fishrock123 Fishrock123 mentioned this pull request Mar 1, 2016
5 tasks
@jasnell
Copy link
Member

jasnell commented Mar 2, 2016

Added the lts watch label...

@Knighton910
Copy link

Great stuff guys/gals

MylesBorins pushed a commit that referenced this pull request Mar 17, 2016
They were not being processed as relative links.

PR-URL: #5358
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this pull request Mar 21, 2016
They were not being processed as relative links.

PR-URL: #5358
Reviewed-By: Roman Reiss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants