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

Advertise impls of out-of-create traits for third party types with some type parameters set to in-crate types in rustdoc #25264

Closed
reem opened this issue May 10, 2015 · 7 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

@reem
Copy link
Contributor

reem commented May 10, 2015

As an example, in iron, the impls of Modifier<Response> for std types like String, File, and Path are not advertised anywhere in the generated documentation.

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

Just wanted to add in, this would be useful for rust-gnome as well, because we're starting to have a few cross-crate trait impls, and, as of now, have no easy way of documenting them.

@steveklabnik steveklabnik added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Nov 15, 2016
@steveklabnik
Copy link
Member

Triage: no change. Given that this is an open set of things, I'm not sure it's something that can ever really be done...

@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
@QuietMisdreavus
Copy link
Member

Just to clarify this: You want to be able to show a trait implementation when one of its type parameters is a local type? i.e. impl From<LocalType> for ForeignType would show on LocalType's page? That might not take too much work, but i'd like to make sure that that's what's being requested.

@jethrogb
Copy link
Contributor

Given that this is an open set of things, I'm not sure it's something that can ever really be done...

Because of the coherence rules, impls can only be defined in one place depending on the types they reference. That's the place they should be documented as well.

@jethrogb
Copy link
Contributor

#42440 was labelled C-bug but this is labelled C-enhancement

@QuietMisdreavus QuietMisdreavus added C-bug Category: This is a bug. and removed C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Sep 29, 2017
@QuietMisdreavus
Copy link
Member

I'll swap the labels, since this is a shortcoming of the generated docs.

@QuietMisdreavus
Copy link
Member

I've opened #44969 to fix this.

bors added a commit that referenced this issue Oct 12, 2017
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

5 participants