Skip to content

Std docs links are not all highlighted #15307

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

Closed
mdinger opened this issue Jul 1, 2014 · 11 comments · Fixed by #29264
Closed

Std docs links are not all highlighted #15307

mdinger opened this issue Jul 1, 2014 · 11 comments · Fixed by #29264
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@mdinger
Copy link
Contributor

mdinger commented Jul 1, 2014

Std doc links should have colors to highlight that they are links:

std2

Some users find it difficult to know which items are links.

[EDIT] Removed sidebar circles. Never thought they needed changing.

@mdinger
Copy link
Contributor Author

mdinger commented Jul 1, 2014

Primitive type f32 has the same issue:
f32_2

[EDIT] Removed sidebar circles. Never thought they needed changing.

@nightpool
Copy link

Totally agree. Also, instead of colors, we could use dashed underlines to indicate links while still keeping the same feel. (I disagree about the sidebar as well, I think its normal to expect those to be links, because they're in a sidebar without any text)

@spencerdeinum
Copy link

Sidebar is fine, thats a pretty normal convention to have those as links.

At first glance I didn't realize most of the text in the main doc area was clickable however, I really like the idea of having the dashed underlines.

+1

@mdinger
Copy link
Contributor Author

mdinger commented Jul 1, 2014

Didn't think sidebar necessarily should change. Was just highlighting black links. Edited pictures to removed sidebar circles.

@nightpool
Copy link

Really quick mockup:

It doesn't show in the screenshot, but the last bool has the mouse over it, so it's darker.

@nightpool
Copy link

code is

#main a {
    border-bottom: dashed 2px #aaa;
}
#main a:hover {
    border-bottom-color: black;
}

and maybe some sort of style so it doesn't show up on the [src] link

@mdinger
Copy link
Contributor Author

mdinger commented Jul 1, 2014

CC: @steveklabnik
Don't have a branch but this is probably a straightforward fix if you decide on a style. Or if you like nightpool's suggestion.

@steveklabnik
Copy link
Member

I like that style, I think. I am bad at looks, though.

@mdinger
Copy link
Contributor Author

mdinger commented Jul 1, 2014

@nightpool If there are any other decent styles worth pursuing (different brown variant, solid underline, combo, red...I'm just guess here), a quick mockup of them would allow easy compare and contrast. It would allow an easier/faster decision.

@steveklabnik steveklabnik added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Feb 11, 2015
@Manishearth
Copy link
Member

+1 from me

@mdinger
Copy link
Contributor Author

mdinger commented Oct 10, 2015

I'm currently playing with rustdoc. I may try to implement this once the docs are built.

steveklabnik added a commit to steveklabnik/rust that referenced this issue Oct 29, 2015
This is an alternative to rust-lang#29240 which fixes rust-lang#15307 by adding colors to primitives and aliases instead of underlining.

Try to keep the discussion in rust-lang#29240 for now though so it can be kept track of.

A sample rendering is [here](http://mdinger.github.io/rust_std_colored/std/index.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
6 participants