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

Docs now have poor information density #13591

Closed
emberian opened this issue Apr 18, 2014 · 9 comments · Fixed by #13776
Closed

Docs now have poor information density #13591

emberian opened this issue Apr 18, 2014 · 9 comments · Fixed by #13776
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@emberian
Copy link
Member

I'm really sorry that I didn't bring this up in the earlier reviews I did of the work, but I was on my desktop with a 1080p screen, and also just didn't notice.

Here are two screenshots:

first

second

I note a few specific regressions:

  • Monospaced text that is inline with other text is now way larger than the other text.
  • References to types/traits/etc in the headers for an impl section are not monospaced
  • Amount of whitespace around impl and impl methods makes much fewer methods fit on screen at once. This isn't very nice, since now I need to scroll a lot more to view the same amount of information.

The first two just seem like bugs (references to items should always be monospaced, perhaps?), but the latter is a more nuanced design decision. It seems to me that there is too much whitespace in general, and that the spacing between almost everything ought to be reduced.

Another point, almost more aesthetic than functional, is that the distance between a header and the line underneath it is slightly too large, and makes it more difficult to view them as a "single unit".

@emberian
Copy link
Member Author

cc @thehydroimpulse @adrientetar

@lifthrasiir
Copy link
Contributor

The lines below headings in the different levels are also indistinguishable now. I'd prefer not to have lines below the non-top-level headings; they can be distinguished with the appropriate amount of spacing.

@bachm
Copy link

bachm commented Apr 19, 2014

The docs were more readable with the previous font. The orange and green text was also more readable on the light grey background than on white.

@adrientetar
Copy link
Contributor

Monospaced text that is inline with other text is now way larger than the other text.

From my investigations, this is not an issue with the actual body copy font.

Consolas:

consolas

Inconsolata:

inconsolata

Seems like Inconsolata has a quite low xheight, I will see about replacing it (have Anonymous Pro or Source Code Pro in mind).

(Note: I had to zoom at 200% to see it and even there it's a tiny difference, so it does not seem too bad to me anyway.)

References to types/traits/etc in the headers for an impl section are not monospaced

Right, fixed on my side.

Amount of whitespace around impl and impl methods makes much fewer methods fit on screen at once. This isn't very nice, since now I need to scroll a lot more to view the same amount of information.

Agreed. I didn't look at such pages while developing the layout, I will fix this.


The docs were more readable with the previous font.

Because it is a serif font? – If so it is a matter of accomodation, few websites make use of them actually (for instance, blog or newspaper).

@adrientetar
Copy link
Contributor

Source Code Pro is looking good? I will add it to #13587.

source

(400% zoom)

@bachm
Copy link

bachm commented Apr 19, 2014

Because it is a serif font?

Mainly due to poor information density, but I simply find Consolas to be more readable than Inconsolata because it's "fatter".

@emberian
Copy link
Member Author

I think I would prefer a sans-serif typeface. The screenshot you gave with source code pro looks good.

@huonw
Copy link
Member

huonw commented Apr 26, 2014

Along these lines: headers within a doc comment now take up a lot of space, and look a lot like they're page layout headings, not just subheadings for a specific function (e.g. the failure heading in http://static.rust-lang.org/doc/master/std/c_str/struct.CString.html#method.with_ref).

@adrientetar
Copy link
Contributor

Along these lines: headers within a doc comment now take up a lot of space, and look a lot like they're page layout headings, not just subheadings for a specific function (e.g. the failure heading in http://static.rust-lang.org/doc/master/std/c_str/struct.CString.html#method.with_ref).

Thanks for the pointer, looks like I only fixed a part of this.

bors added a commit that referenced this issue Apr 30, 2014
- Closes #13591. Relevant example: http://adrientetar.legtux.org/cached/rust-docs/struct.CChars.htm
(Had to use `!important` to override CSS selector precedence, namely matching over parent class.)
- Implement changes from #13780 feedback, namely:
  * Changed font-size from 18px to 15px
  * Reintroduced gray background for code samples
  * Tightened up the margins
- Fix point 1 and point 4 of #13804.

Samples:

- [enum.FileType](http://adrientetar.legtux.org/cached/rust-docs/enum.FileType.htm)
- [struct.CChars](http://adrientetar.legtux.org/cached/rust-docs/struct.CChars.htm)
- [std](http://adrientetar.legtux.org/cached/rust-docs/std.htm)
- [std::io](http://adrientetar.legtux.org/cached/rust-docs/io.htm).

r? @brson
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants