Skip to content

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

Merged
bors merged 1 commit into
rust-lang:masterfrom
QuietMisdreavus:method-src
Jul 30, 2017
Merged

rustdoc: add [src] links to associated functions inside an impl block#43509
bors merged 1 commit into
rust-lang:masterfrom
QuietMisdreavus:method-src

Conversation

@QuietMisdreavus

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Contributor

Some changes occurred in HTML/CSS.

cc @GuillaumeGomez

@rust-highfive

Copy link
Copy Markdown
Contributor

r? @steveklabnik

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

@QuietMisdreavus

Copy link
Copy Markdown
ContributorAuthor

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

@GuillaumeGomez

Copy link
Copy Markdown
Member

Awesome, thanks!

@bors: r+

@bors

bors commented Jul 27, 2017

Copy link
Copy Markdown
Collaborator

📌 Commit c9bdd51 has been approved by GuillaumeGomez

@alexcrichtonalexcrichton 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
Copy Markdown
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.
fixesrust-lang#12932
![methods on HashMap, showing the new src links](https://user-images.githubusercontent.com/5217170/28686066-9e7a19de-72cf-11e7-8e6b-b7d60fa33032.png)
@frewsxcvfrewsxcv mentioned this pull request Jul 29, 2017
@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.
fixesrust-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:masterJul 30, 2017
@kennytm

Copy link
Copy Markdown
Member

@bors p=-2 (unblock bors)

@QuietMisdreavus
QuietMisdreavus deleted the method-src branch August 2, 2017 15:29
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: 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

@QuietMisdreavus@rust-highfive@GuillaumeGomez@bors@Mark-Simulacrum@kennytm@steveklabnik@alexcrichton