Repository navigation
doc: markdown links do not turn into real links #5322
Description
Hey,
I noticed that in various docs, links are not shown and actual markdown appears instead.
Examples:
- In tls.html:
tlsSocket is the [tls.TLSSocket][] that the error originated from. - In net.html:
The parameter backlog behaves the same as in [server.listen(port, \[host\], \[backlog\], \[callback\])][]. - In cluster.html:
When no more connections exist, see [server.close()][], the IPC channel to the worker will close allowing it to die gracefully. - In crypto.html:
Use [crypto.getCurves()][] to obtain a list of available curve names.
Activity
estliberitas commentedon Feb 19, 2016
Already fixed but not landed yet by #5230.
estliberitas commentedon Feb 19, 2016
Also here: https://nodejs.org/docs/latest-v5.x/api/errors.html:
[EvalError][] ... [RangeError][] ... [URIError][]Update: will fix in separate PR. It's about doc tool
Another update: this is not about doc tool, I was wrong, but actually this would be good to fix with doc tool (using types parser) by adding
EvalErrorRangeErrorReferenceErrorSyntaxErrorTypeErrorURIErrorto global types list, so we can write just
{SyntaxError}and all.Actually, I'm wondering why not make type parser produce such links with
<code></code>...estliberitas commentedon Feb 19, 2016
Also here: https://nodejs.org/docs/latest/api/console.html#console_console_dir_obj_options
Wondering if latest docs are not updated OR doc tool does not parse such links correctly.
Update: just checked with latest master locally, all is OK
estliberitas commentedon Feb 19, 2016
After debugging of
markedpackage I found that it does not support links with]character even if it's escaped. Regular expression responsible for parsing link definitions would not allow such case. The problem is in reference resolving part:\[([^\]]+)\]:. This means it will not parse things like[foo(\[bar\])].Any thoughts on this? I can resolve this simply in a PR by removing
[and]from link titles. But it would break meaning of those signatures a bit./cc @mscdex @thefourtheye guys I did not know who to ask, so asking you...
thefourtheye commentedon Feb 19, 2016
cc @nodejs/documentation
estliberitas commentedon Feb 19, 2016
@thefourtheye thx, now I know who to /cc 😉
evanlucas commentedon Feb 22, 2016
ah, just saw this. The net issues should be fixed by #5358
estliberitas commentedon Feb 22, 2016
tls and cluster links should be fixed by #5364.
doc: fix links in tls, cluster docs
doc: fix links in tls, cluster docs
evanlucas commentedon Mar 8, 2016
Closing as all of the listed broken links have been fixed. Thanks for reporting!
jhamhader commentedon Mar 8, 2016
@evanlucas Problem still exists in:
evanlucas commentedon Mar 8, 2016
@jhamhader do you have links to them? I must be missing something. I'm not seeing them
2 remaining items
stevemao commentedon Mar 10, 2016
I confirm @jhamhader is correct.
Please reopen this.
PR income :)
doc: fix markdown links
doc: fix markdown links
doc: fix markdown links
doc: fix links in tls, cluster docs
doc: fix markdown links
doc: fix markdown links
doc: fix links in tls, cluster docs
doc: fix markdown links