Skip to content

Rustdoc mis-parses links with spaces #29483

New issue

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

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

Already on GitHub? # to your account

Closed
steveklabnik opened this issue Oct 30, 2015 · 8 comments
Closed

Rustdoc mis-parses links with spaces #29483

steveklabnik opened this issue Oct 30, 2015 · 8 comments
Labels
T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@steveklabnik
Copy link
Member

If you're using a reference-style link with a parenthetical statement after it:

//! blah blah blah [something] (also known as bar)
//!
//! [something]: whatever.html

This will ignore the reference and link to also known as bar.

CommonMark says:
http://spec.commonmark.org/0.21/#example-460

[Whitespace] is not allowed between the link text and the following parenthesis:

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Oct 30, 2015
@nagisa
Copy link
Member

nagisa commented Oct 30, 2015

Hoedown does not target CommonMark.

@steveklabnik
Copy link
Member Author

Yeah, this and #29481 might both entirely be upstream, but I wanted to 1) make a note to investigate later and 2) have some sort of documentation that things might diverge from expected, for future searchers. :)

I would like to switch to something CommonMark compliant, personally.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Oct 30, 2015
@durka
Copy link
Contributor

durka commented Nov 4, 2015

@nagisa this claims Hoedown actually does target CommonMark.

@steveklabnik
Copy link
Member Author

Triage: no change.

@durka
Copy link
Contributor

durka commented Nov 15, 2016

@steveklabnik have this an #29481 been filed as Hoedown bugs? Worst they could do is say "not our problem". Though, hoedown looks unmaintained.

@steveklabnik
Copy link
Member Author

I don't believe they have, mostly because I would prefer to port rustdoc to pulldown-cmark to eliminate yet another c dependency.

@frewsxcv
Copy link
Member

Opened an issue for moving to pulldown-cmark: #38400

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@Mark-Simulacrum
Copy link
Member

Work with --enable-commonmark so I'm going to go ahead and close.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants