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.

Sign up for GitHub

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

Jump to bottom

Unescaped HTML in unstable reason #38220

Closed
jleedev opened this issue Dec 7, 2016 · 1 comment
Closed

Unescaped HTML in unstable reason #38220

jleedev opened this issue Dec 7, 2016 · 1 comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jleedev
Copy link

jleedev commented Dec 7, 2016

The docs for FnBox (https://doc.rust-lang.org/std/boxed/trait.FnBox.html) contain this line in the rendered output:

will be deprecated if and when Box becomes usable

In the HTML source, this is the unescaped Box<FnOnce> instead of the escaped Box&lt;FnOnce&gt;.
@bluss bluss added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Dec 7, 2016
@durka
Copy link
Contributor

durka commented Dec 7, 2016

rustdoc needs to do the escaping. The reasons are also printed in error messages to the console.

@estebank estebank mentioned this issue Dec 8, 2016
Merged
bors added a commit that referenced this issue Jan 9, 2017
@bors
Auto merge of #38244 - estebank:escape-reason-docs, r=ollie27
9749df5 
rustdoc: escape the deprecated and unstable reason text

Fix #38220.
Instead of the [current output](https://doc.rust-lang.org/std/boxed/trait.FnBox.html):

<img width="967" alt="incorrect unescaped unstable reason in docs" src="https://cloud.githubusercontent.com/assets/1606434/21021898/73121d42-bd2f-11e6-8076-8a5127dbc010.png">

display:

<img width="979" alt="escaped unstable reason in docs" src="https://cloud.githubusercontent.com/assets/1606434/21021876/52eb0f88-bd2f-11e6-9088-58bdc7d92328.png">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jleedev @durka @bluss