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 exposes private use rebindings in the signature of public functions. #49331

Open
Lymia opened this issue Mar 24, 2018 · 1 comment
Open
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Lymia
Copy link
Contributor

Lymia commented Mar 24, 2018

Rust will document the test function the following code as taking a ThisIsTotallyNotAnOption<String> rather than a Option<String>. This is confusing at first glance because without looking at the source or actually following the link, there is no indication as to what the type actually is.

use std::option::{Option as ThisIsTotallyNotAnOption};
pub fn test(o: ThisIsTotallyNotAnOption<String>) { }
@kennytm kennytm added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. labels Mar 24, 2018
@steveklabnik
Copy link
Member

Triage: this reproduces today

image

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-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