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: add [src] links to associated functions inside an impl block #43509

Merged
merged 1 commit into from
Jul 30, 2017

Conversation

QuietMisdreavus
Copy link
Member

While impl blocks currently have a [src] link to show the source for the impl block as a whole, individual methods inside that impl block do not. This can pose a problem for structs with a lot of methods, like many in libstd. This change adds little [src] links to individual methods that point directly to the function in the bundled source.

fixes #12932

methods on HashMap, showing the new src links

@rust-highfive
Copy link
Collaborator

Some changes occurred in HTML/CSS.

cc @GuillaumeGomez

@rust-highfive
Copy link
Collaborator

r? @steveklabnik

(rust_highfive has picked a reviewer for you, use r? to override)

@QuietMisdreavus
Copy link
Member Author

I've got a rendering of the libstd docs in case you want to preview this yourself.

@GuillaumeGomez
Copy link
Member

Awesome, thanks!

@bors: r+

@bors
Copy link
Contributor

bors commented Jul 27, 2017

📌 Commit c9bdd51 has been approved by GuillaumeGomez

@alexcrichton alexcrichton added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jul 27, 2017
@Mark-Simulacrum
Copy link
Member

@bors rollup

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Jul 29, 2017
…aumeGomez

rustdoc: add [src] links to associated functions inside an impl block

While impl blocks currently have a `[src]` link to show the source for the impl block as a whole, individual methods inside that impl block do not. This can pose a problem for structs with a lot of methods, like many in libstd. This change adds little `[src]` links to individual methods that point directly to the function in the bundled source.

fixes rust-lang#12932

![methods on HashMap, showing the new src links](https://user-images.githubusercontent.com/5217170/28686066-9e7a19de-72cf-11e7-8e6b-b7d60fa33032.png)
@GuillaumeGomez GuillaumeGomez self-requested a review July 29, 2017 14:21
Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this pull request Jul 30, 2017
…aumeGomez

rustdoc: add [src] links to associated functions inside an impl block

While impl blocks currently have a `[src]` link to show the source for the impl block as a whole, individual methods inside that impl block do not. This can pose a problem for structs with a lot of methods, like many in libstd. This change adds little `[src]` links to individual methods that point directly to the function in the bundled source.

fixes rust-lang#12932

![methods on HashMap, showing the new src links](https://user-images.githubusercontent.com/5217170/28686066-9e7a19de-72cf-11e7-8e6b-b7d60fa33032.png)
bors added a commit that referenced this pull request Jul 30, 2017
Rollup of 8 pull requests

- Successful merges: #43409, #43501, #43509, #43512, #43513, #43536, #43544, #43549
- Failed merges:
@bors bors merged commit c9bdd51 into rust-lang:master Jul 30, 2017
@kennytm
Copy link
Member

kennytm commented Jul 31, 2017

@bors p=-2 (unblock bors)

@QuietMisdreavus QuietMisdreavus deleted the method-src branch August 2, 2017 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rustdoc should show [src] link for methods
8 participants