-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Hovering a type alias should render documentation of the aliased type if it lacks docs #18344
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
Comments
@rustbot claim |
I wonder if we should also show the signature of the aliased item, or only its docs. E.g. the docs may refer to its name or type parameters which don't exist in the alias. |
@ChayimFriedman2 So, in the snippet below, we should show /// Docs for [`B`]
struct B;
type A = B; By showing type aliases for type parameters, I think we should just keep as is, to avoid showing type A = Box<u32> |
Well, I found it rather hard if we need to rename the aliased type in the docs. Seem relate to #8242. |
I don't think it's possible to rename the docs. Not every usage is a link, while not every same text is a reference, and modifying only some of the usages will be very confusing. |
No, we should definitely include |
Why rename things? Just render the docs of the aliased thing, no need to overcomplicate this (and maybe indicate that its the docs from a different item) |
Thank you, I'll try implementing this |
Hovering
T
should yield theDocs for S
documentation.The text was updated successfully, but these errors were encountered: