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: Trait object (e.g. impl Any) inherent methods are not properly documented #19055

Closed
japaric opened this issue Nov 18, 2014 · 2 comments
Assignees
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@japaric
Copy link
Member

japaric commented Nov 18, 2014

STR

pub trait Any {}

impl<'any> Any + 'any {
    /// Returns true if the boxed type is the same as `T`
    pub fn is<T: 'static>(&self) -> bool { unimplemented!() }

    /// Returns some reference to the boxed value if it is of type `T`, or
    /// `None` if it isn't.
    pub fn downcast_ref<'a, T: 'static>(&'a self) -> Option<&'a T> { unimplemented!() }

    /// Returns some mutable reference to the boxed value if it is of type `T`, or
    /// `None` if it isn't.
    pub fn downcast_mut<'a, T: 'static>(&'a mut self) -> Option<&'a mut T> { unimplemented!() }
}

Output

Any's inherent methods appear in the search index:

search

But upon clicking the method, you land in the Any main page:

nothing

Where the methods don't show up

@japaric
Copy link
Member Author

japaric commented Nov 18, 2014

Hmm, also if you do impl Show for Any, should that implementation show up in the Any main page? (because it doesn't)

@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jan 29, 2015
@jdm
Copy link
Contributor

jdm commented Feb 5, 2015

Now those search results take you to 404s.

@alexcrichton alexcrichton self-assigned this Apr 7, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

4 participants