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: enum fields should use fully-qualified type #86640

Closed
jsha opened this issue Jun 26, 2021 · 2 comments
Closed

rustdoc: enum fields should use fully-qualified type #86640

jsha opened this issue Jun 26, 2021 · 2 comments
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Jun 26, 2021

Right now, when an enum field is rendered, it uses the bare type name without module or crate qualifiers. For instance: https://docs.rs/rustls/0.19.1/rustls/enum.TLSError.html

pub enum TLSError {
    ...
    WebPKIError(Error),
    InvalidSCT(Error),

Those Error are two different error types from other crates: webpki::Error and sct::Error. And indeed you can see that by hovering them. I think the displayed name should also use the fully qualified form.

@jsha jsha added the A-rustdoc-ui Area: Rustdoc UI (generated HTML) label Jun 26, 2021
@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 26, 2021
@jyn514
Copy link
Member

jyn514 commented Jun 26, 2021

This is a duplicate of an existing issue, but I can't find it.

@camelid
Copy link
Member

camelid commented Jul 5, 2021

I found it: #42066.

@jyn514 jyn514 closed this as completed Jul 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) 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

3 participants