Skip to content

Hidden methods still appear in trait implementation docs #13698

Closed
@chris-morgan

Description

@chris-morgan
Member

Take, for example, TotalEq:

pub trait TotalEq: Eq {
    // FIXME #13101: this method is used solely by #[deriving] to
    // assert that every component of a type implements #[deriving]
    // itself, the current deriving infrastructure means doing this
    // assertion without using a method on this trait is nearly
    // impossible.
    //
    // This should never be implemented by hand.
    #[doc(hidden)]
    #[inline(always)]
    fn assert_receiver_is_total_eq(&self) {}
}

As is proper, the TotalEq docs make no mention of this hidden method assert_receiver_is_total_eq.

But now refer to an example like the TotalEq impl for Option! Lo! assert_receiver_is_total_eq is shown there.

It shouldn't be.

Activity

added a commit that references this issue on Apr 23, 2014
2cf1e4b
mahkoh

mahkoh commented on Mar 5, 2015

@mahkoh
Contributor

This is broken again.

reopened this on Apr 4, 2015
mitsuhiko

mitsuhiko commented on Apr 4, 2015

@mitsuhiko
Contributor
self-assigned this
on Apr 7, 2015
SimonSapin

SimonSapin commented on May 29, 2018

@SimonSapin
Contributor

It looks like this is happening again in #51147 (comment).

20 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

C-bugCategory: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Participants

    @mitsuhiko@kzys@alexcrichton@SimonSapin@chris-morgan

    Issue actions

      Hidden methods still appear in trait implementation docs · Issue #13698 · rust-lang/rust