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

Rust docs should at least have the option of using sans-serif fonts #52449

Open
ghost opened this issue Jul 17, 2018 · 5 comments
Open

Rust docs should at least have the option of using sans-serif fonts #52449

ghost opened this issue Jul 17, 2018 · 5 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@ghost
Copy link

ghost commented Jul 17, 2018

Edit: When I say "docs" I mean the standard library docs. The font in places like "The Book" is absolutely fine.

I'm sure I've seen this brought up in the issues before, but I don't seem to be able to find those issues anymore because I can't remember what I searched, so I hope you don't mind me creating a new issue for this.

Currently the rust docs only really display all text in a serif style font, which is extremely difficult to read, especially when there are large sections of bold text.

I understand that this may be a deliberate design decision, but unfortunately it makes it hard for people like me (no disabilities, just bad eyesight) to read anything. In my case I don't care about the design, I just want to be able to read the text without straining my eyes.

If the docs can't be changed to a sans-serif font by default, then could an option at least be provided to change the font to a sans-serif one instead?

Even the default font-family: sans-serif; is fine. Anything but serif will do for me.

Currently when I open the docs I have to open the inspector in Chrome and apply font-family: sans-serif; to the entire site just to get anything done. This works but I shouldn't really have to do this in the first place.

A serif font is fine for short pieces of text, like titles for example, but for the main body of text I hope a sans-serif font option can be seriously considered.

I hope I'm not missing anything. If there's already an option to do this then please let me know.

@scottmcm
Copy link
Member

Maybe just use the default font in the user's browser? Though personally I just override all fonts anyway...

@hellow554
Copy link
Contributor

I think we should hear @GuillaumeGomez for his opinion.

IMHO: I really think, that serif fonts are good for large block texts, because they will help you with read flow. This is my opinions and I have the feeling, that it does not suits you. Code and captions are always sanserif.
I think the best solution would be a browser plugin, that will give you the option to replace the font (not manually, but you create a rule for a certain website).

@GuillaumeGomez
Copy link
Member

I can add a setting to allow the switch if you want? Well, if I find it more comfortable to read, I'll set it as default. :)

@ghost
Copy link
Author

ghost commented Jul 19, 2018

@hellow554 I did think of using a plugin for myself, but in general websites use sans-serif because it's more readable for more people in large blocks of text, so I'm sure I can't be the only one that has a problem with the font in the standard library docs.

In that case I thought it would be best if the docs either changed to sans-serif or at least provided an option to change for people who can't read serif fonts easily (like me).

Another minor reason for a font face change could also just be out of consistency. I don't keep up with the development of the Rust language itself too closely, but from what I've seen people seem to value consistency here, so it's strikes me as odd that the docs and the books, which all get lumped together on the initial page after running rustup doc, don't have consistent font faces. It's a bit jarring to jump between them so suddenly (and I prefer the font faces in places like "The Book" anyway).

@GuillaumeGomez If the font can't be sans-serif by default then some kind of option somewhere would be great. As @hellow554 pointed out it would be possible for users to just install a plugin in their browser and customise it themselves, but an option somewhere on the page that sets a cookie to remember font choice would be the best solution since it doesn't require users to know how to customise their browser.

@steveklabnik
Copy link
Member

steveklabnik commented Jul 19, 2018 via email

@estebank estebank added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Jan 8, 2019
@jonas-schievink jonas-schievink added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

6 participants