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: make major section headers self-links #43445

Merged
merged 1 commit into from
Jul 27, 2017

Conversation

zackmdavis
Copy link
Member

The sidebar already has links to these h2's ids, but for convenience,
the h2 itself should also be a link (retaining its present appearance).

doc_sec_self-links

This should address most of #24484.

The sidebar already has links to these h2's ids, but for convenience,
the h2 itself should also be a link (retaining its present appearance).

This should address most of rust-lang#24484.
@rust-highfive
Copy link
Collaborator

r? @GuillaumeGomez

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

Copy link
Member

@killercup killercup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Does not add IDs, just links to headlines.

Personally, I'd prefer to not link the entire headline, just the symbol (doesn't need to be § either, but makes sense), but I think this way it's easier to discover and actually use.

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Jul 24, 2017

Indeed, thanks!

@bors: r+

@bors
Copy link
Contributor

bors commented Jul 24, 2017

📌 Commit 09fc36e has been approved by GuillaumeGomez

@carols10cents carols10cents added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Jul 24, 2017
@bors
Copy link
Contributor

bors commented Jul 26, 2017

⌛ Testing commit 09fc36e with merge 3c12233...

bors added a commit that referenced this pull request Jul 26, 2017
…=GuillaumeGomez

rustdoc: make major section headers self-links

The sidebar already has links to these h2's ids, but for convenience,
the h2 itself should also be a link (retaining its present appearance).

![doc_sec_self-links](https://user-images.githubusercontent.com/1076988/28503806-cdce4e00-6fc1-11e7-832a-2ed1fc62808f.png)

This should address most of #24484.
@bors
Copy link
Contributor

bors commented Jul 26, 2017

💔 Test failed - status-appveyor

@Mark-Simulacrum
Copy link
Member

@bors retry - #43453 rls tests

@bors
Copy link
Contributor

bors commented Jul 27, 2017

⌛ Testing commit 09fc36e with merge 4a42ff4...

bors added a commit that referenced this pull request Jul 27, 2017
…=GuillaumeGomez

rustdoc: make major section headers self-links

The sidebar already has links to these h2's ids, but for convenience,
the h2 itself should also be a link (retaining its present appearance).

![doc_sec_self-links](https://user-images.githubusercontent.com/1076988/28503806-cdce4e00-6fc1-11e7-832a-2ed1fc62808f.png)

This should address most of #24484.
@bors
Copy link
Contributor

bors commented Jul 27, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: GuillaumeGomez
Pushing 4a42ff4 to master...

@bors bors merged commit 09fc36e into rust-lang:master Jul 27, 2017
@zackmdavis zackmdavis deleted the rustdoc_major_section_self-links branch January 13, 2018 07:43
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.

7 participants