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

rustdoc generates where clauses that are not valid Rust #28360

Closed
jimblandy opened this issue Sep 11, 2015 · 4 comments
Closed

rustdoc generates where clauses that are not valid Rust #28360

jimblandy opened this issue Sep 11, 2015 · 4 comments
Labels
C-bug Category: This is a bug. 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

@jimblandy
Copy link
Contributor

At the moment, the summary for the IntoIterator trait definition reads:

pub trait IntoIterator where Self::IntoIter::Item == Self::Item {
    type Item;
    type IntoIter: Iterator;
    fn into_iter(self) -> Self::IntoIter;
}

The 'where' clause on the first line isn't valid Rust, which is confusing. It should instead be rendered the way it appears in the code:

pub trait IntoIterator {
    type Item;
    type IntoIter: Iterator<Item=Self::Item>;
    fn into_iter(self) -> Self::IntoIter;
}

(On #rust @alexcrichton said, "that's probably all located in https://github.com/rust-lang/rust/blob/master/src/librustdoc/clean/simplify.rs")

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

Triage: no change. Still.

@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 Mark-Simulacrum added the C-bug Category: This is a bug. label Jul 24, 2017
@Mark-Simulacrum
Copy link
Member

Well, arguably, rustdoc is just ahead of it's time: #20041.

@steveklabnik
Copy link
Member

Triage: no change, and 20041 hasn't landed yet.

@jyn514
Copy link
Member

jyn514 commented Dec 15, 2020

Duplicate of #77763 (I know this was filed earlier, but that issue has more details).

@jyn514 jyn514 closed this as completed Dec 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. 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

4 participants