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

Documentation page for rustc_middle::ty::List is malformed #73676

Closed
arora-aman opened this issue Jun 24, 2020 · 8 comments · Fixed by #73748
Closed

Documentation page for rustc_middle::ty::List is malformed #73676

arora-aman opened this issue Jun 24, 2020 · 8 comments · Fixed by #73748
Assignees
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.

Comments

@arora-aman
Copy link
Member

arora-aman commented Jun 24, 2020

Documentation generated for

/// trait X<S> { fn f<T>(); }
/// impl<U> X<U> for U { fn f<V>() {} }

and any code after is all strikethrough because of the <S>.

Generated doc: Here

Associated src code: Here

cc: @jyn514

This issue has been assigned to @jyn514 via this comment.

@jyn514
Copy link
Member

jyn514 commented Jun 24, 2020

@rustbot modify labels: T-rustdoc C-bug

@rustbot rustbot added C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 24, 2020
@ehuss
Copy link
Contributor

ehuss commented Jun 24, 2020

This is normal and expected markdown behavior.

trait X { fn f(); }
impl X for U { fn f() {} }

It needs to be placed in a code block to avoid that (or use escapes).

@crlf0710
Copy link
Member

It affecting that specific piece of item doc - expected behavior
It affecting the rest of page - duplicate of #67799

@nagisa
Copy link
Member

nagisa commented Jun 26, 2020

Duplicate of #67799

@nagisa nagisa marked this as a duplicate of #67799 Jun 26, 2020
@nagisa nagisa closed this as completed Jun 26, 2020
@jyn514
Copy link
Member

jyn514 commented Jun 26, 2020

I don't think this should be closed until the docs for https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/ty/struct.List.html#impl-HashStable%3CStableHashingContext%3C%27a%3E%3E are changed not to have strikethroughs everywhere.

@nagisa nagisa changed the title Rustdoc doesn't escape Angular Brackets Documentation page for rustc_middle::ty::List is malformed Jun 26, 2020
@nagisa
Copy link
Member

nagisa commented Jun 26, 2020

Sure, adjusted the title to better reflect the scope of the issue.

@nagisa nagisa reopened this Jun 26, 2020
@jyn514
Copy link
Member

jyn514 commented Jun 26, 2020

@rustbot claim

@jyn514
Copy link
Member

jyn514 commented Jun 26, 2020

@rustbot modify labels: -T-rustdoc +T-doc

@rustbot rustbot added A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 26, 2020
@bors bors closed this as completed in a7eee3c Jun 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants