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

Broken link/formatting in docs for std #29552

Closed
Thinkofname opened this issue Nov 4, 2015 · 5 comments
Closed

Broken link/formatting in docs for std #29552

Thinkofname opened this issue Nov 4, 2015 · 5 comments
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@Thinkofname
Copy link

https://doc.rust-lang.org/nightly/std/

The line
documents the constant values [MIN] and MAX.

MAX links to https://doc.rust-lang.org/nightly/std/rarely%20useful . Looking at the source it looks like rustdoc ignored the space between ] and ( and made it a link.

@steveklabnik
Copy link
Member

Gah! This is #29483. I recently changed this, and it missed my manual inspection.

@steveklabnik steveklabnik added A-docs E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. labels Nov 4, 2015
@steveklabnik
Copy link
Member

For anyone that wants to fix this, the idea is to change line 79 of src/libstd/lib.rs to use the inline link syntax, [](). Which also means removing line 156, where the target is.

I'm making this a part of #29429 so we don't ship a release without the fix, but if you're interested in helping out, please do it before I get to it!

@steveklabnik
Copy link
Member

Take the [] and make it a style link instead, basically. The URL is down below, since it's a footnote-style link right now.

Sent from my iPhone

On Nov 5, 2015, at 17:57, Rizky Luthfianto [email protected] wrote:

Pardon me, I didn't understand. Would a backslash fix it?


Reply to this email directly or view it on GitHub.

@abhijeetbhagat
Copy link
Contributor

I can do this. Shall i?

@steveklabnik
Copy link
Member

#29624 fixed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Development

No branches or pull requests

3 participants