Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rustdoc: inline methods available through blanket impls #25608

Closed
SimonSapin opened this issue May 19, 2015 · 2 comments
Closed

Rustdoc: inline methods available through blanket impls #25608

SimonSapin opened this issue May 19, 2015 · 2 comments
Labels
T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@SimonSapin
Copy link
Contributor

On reddit: https://www.reddit.com/r/rust/comments/36f94o/how_do_i_read_the_api_docs/

I had a terrible time with the API docs. Take str... I know I can use to_string() on it because I saw a web page that said I could, but I can't seem to infer that from the docs. Then I search for to_string() and get this page, but it doesn't seem to apply to str types.

What’s going on is that the to_string() method is on the ToString trait which has a blanket impl

impl<T> ToString for T where T: Display + ?Sized

… and str implements Display.

So in the spirit of #19190 (show methods available through deref), rustdoc should also show methods available through blanket implementations.

@Aatch Aatch added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 20, 2015
@steveklabnik
Copy link
Member

Triage: no change

@steveklabnik steveklabnik added T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. and removed T-tools labels May 18, 2017
@QuietMisdreavus
Copy link
Member

Closing as duplicate in favor of #33772, which had more discussion.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. 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