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

Rustdoc: render implementations for type aliases #25892

Closed
wants to merge 2 commits into from
Closed

Rustdoc: render implementations for type aliases #25892

wants to merge 2 commits into from

Conversation

gkoz
Copy link
Contributor

@gkoz gkoz commented May 29, 2015

For typedefs render items implemented for the type under both new and old names.
Fixes (very narrowly) #19381.

gkoz added 2 commits May 30, 2015 01:28
@gkoz
Rustdoc: let render_assoc_items render items of several types at once
f2c3bc4 
This will allow showing trait implementations associated with different
aliases of the same type together.
@gkoz
Rustdoc: render implementations for type aliases
675e018 
For typedefs render items implemented for the type under both new and old names.
Fixes (very narrowly) #19381.
@rust-highfive
Copy link
Collaborator

r? @cmr

(rust_highfive has picked a reviewer for you, use r? to override)

@gkoz
Copy link
Contributor Author

gkoz commented May 29, 2015

I'm going to need help adding a test case.

@gkoz gkoz changed the title Rustdoc: render trait implementations for type aliases Rustdoc: render implementations for type aliases May 29, 2015
@Gankra
Copy link
Contributor

Gankra commented May 30, 2015

Would it be possible to post screenshots, and/or host a live instance with this change?

@gkoz
Copy link
Contributor Author

gkoz commented May 30, 2015

Rendered libstd docs.
io::Result before/after.

@bluss
Copy link
Member

bluss commented May 31, 2015

The bug you linked is a different issue I think.

@gkoz
Copy link
Contributor Author

gkoz commented May 31, 2015

What was I thinking... It fixes half of that bug not the 'Implementors' part.

@alexcrichton
Copy link
Member

Yes I agree with @bluss that I don't think this quite fixes #19381, and I'm also not sure if we want to take this route just yet due to #14072. For example on the documentation page for io::Result the parameter E is generic instead of being wired up to Error.

I suppose it's also somewhat unclear to me what the motivation for this is because finding the documentation of the typedef itself should just be following a link.

@gkoz gkoz closed this Jun 1, 2015
@gsingh93 gsingh93 mentioned this pull request Jun 4, 2015
Closed
@mjkillough mjkillough mentioned this pull request May 15, 2017
Closed
@leighmcculloch
Copy link

@alexcrichton What would need to change about this fix to make it more suitable? It looks like this would address #32077.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@emberian emberian

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@gkoz @rust-highfive @Gankra @bluss @alexcrichton @leighmcculloch @emberian