Skip to content

Hidden methods still appear in trait implementation docs #13698

Closed
@chris-morgan

Description

@chris-morgan

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.

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

Development

No branches or pull requests

Issue actions