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.

Sign up for GitHub

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

Jump to bottom

Rustdoc inlined Deref impls should not include static methods. #24575

Closed
Stebalien opened this issue Apr 18, 2015 · 2 comments · Fixed by #24657
Closed

Rustdoc inlined Deref impls should not include static methods. #24575

Stebalien opened this issue Apr 18, 2015 · 2 comments · Fixed by #24657
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@Stebalien
Copy link
Contributor

As of #24396, rustdoc inlines Deref impls (:smiley:). However, static methods are also included. Static methods probably shouldn't be included as they can't be called through Deref. They also appear to mess with search results.
@steveklabnik steveklabnik added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 18, 2015
@aochagavia aochagavia mentioned this issue Apr 21, 2015
Merged
@aochagavia
Copy link
Contributor

What about methods that take &mut self? Should we hide those too?

@alexcrichton
Copy link
Member

@aochagavia nah I think including those is fine because they are applicable to a DerefMut implementation. In theory the "most correct" thing to do would be to detect whether DerefMut is implemented or not but it's also fine to not do that for now.

@bluss bluss mentioned this issue May 25, 2015
Closed
bors added a commit that referenced this issue May 26, 2015
@bors
Auto merge of #24657 - aochagavia:rustdoc, r=alexcrichton
1742a01 
Fixes #24575 
Fixes #25673 

r? @alexcrichton
XMPPwocky pushed a commit to XMPPwocky/rust that referenced this issue May 29, 2015
@aochagavia @XMPPwocky
Rustdoc: ignore deref-inherited static methods
03d9eb9 
Fixes rust-lang#24575
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rustdoc: ignore deref-inherited static methods
4 participants
@steveklabnik @alexcrichton @Stebalien @aochagavia