Skip to content

Linkify more things in rustdoc #24484

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

Jump to bottom
Closed
8 tasks done
mdinger opened this issue Apr 15, 2015 · 4 comments
Closed
8 tasks done

Linkify more things in rustdoc #24484

mdinger opened this issue Apr 15, 2015 · 4 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. 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

@mdinger
Copy link
Contributor

mdinger commented Apr 15, 2015 •
edited by QuietMisdreavus
Loading

A page like vec has many things that could be useful to link to. These should be possible to link to by clicking on:

  • The Trait Implementations header
  • impl's on a page.
  • Methods at the top

On index it's hit or miss:

  • Examples
  • Associated Types
  • Required Methods
  • Implementors

On clone

  • Provided Methods

I don't have any big use cases but when I want to link to these for something like this bug I can't link to any specific line. I gotta say go to vec page, scroll 75% to bottom. Squint hard to see it.
@alexcrichton alexcrichton added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 15, 2015
@joshtriplett
Copy link
Member

Just ran into this today; I'd really like to have links from the impls in the Implementors section to the source containing the impl.

@briansmith briansmith mentioned this issue Sep 21, 2015
Closed
@steveklabnik
Copy link
Member

Triage: we always need more links....

@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
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 22, 2017
zackmdavis added a commit to zackmdavis/rust that referenced this issue Jul 23, 2017
@zackmdavis
rustdoc: make major section headers self-links
09fc36e 
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.
@zackmdavis zackmdavis mentioned this issue Jul 23, 2017
Merged
bors added a commit that referenced this issue Jul 26, 2017
@bors
Auto merge of #43445 - zackmdavis:rustdoc_major_section_self-links, r…
3c12233 
…=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 added a commit that referenced this issue Jul 27, 2017
@bors
Auto merge of #43445 - zackmdavis:rustdoc_major_section_self-links, r…
4a42ff4 
…=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.
@QuietMisdreavus
Copy link
Member

Update: Headers written in docs and (most) auto-generated headers are either fully hyperlinked or have a "section marker" symbol that shows up on hover. Major auto-generated page headers have links in the top of the sidebar of the page. Impl blocks do not have hyperlinks (yet); that's #23552.

@QuietMisdreavus QuietMisdreavus mentioned this issue Aug 15, 2017
Open
@QuietMisdreavus
Copy link
Member

Since #43979 got merged and closed out #23552, that was the last major request on this issue, so i'll close this out. If you think of something else that needs a hyperlinked header, feel free to open a new issue or reopen this one.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. 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
Milestone
No milestone
Development

No branches or pull requests
6 participants
@steveklabnik @alexcrichton @joshtriplett @mdinger @Mark-Simulacrum @QuietMisdreavus