Skip to content

Rustdoc render inconsistency #13804

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.

Sign up for GitHub

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

Jump to bottom
Closed
lifthrasiir opened this issue Apr 27, 2014 · 3 comments
Closed

Rustdoc render inconsistency #13804

lifthrasiir opened this issue Apr 27, 2014 · 3 comments

Comments

@lifthrasiir
Copy link
Contributor

There are a number of inconsistencies in the current rustdoc renders, including:

  • The method listing for structs/enums has a different look from that for traits. For example, the method heading for structs/enums is bolder than that for traits (font-weight: 600 vs. font-weight: 400).
  • Several non-generated headings (e.g. "Required Methods" in the trait) don't have a link to self.
  • Why is the stability index rendered as <a> instead of <span>?
  • Item listings in the module should have one-line descriptions, but sometimes descriptions span more than one line (e.g. std::kinds::marker). I suspect that's because code has white-space: pre-wrap attribute everywhere; .docblock.short code { white-space: nowrap; } seems to solve that (not sure).
@lifthrasiir lifthrasiir mentioned this issue Apr 27, 2014
Closed
@adrientetar
Copy link
Contributor

cc me

@adrientetar
Copy link
Contributor

I added a fix for part 1 and part 4 of #13804 as part of #13776. #13802 takes care of the rest?

@adrientetar adrientetar mentioned this issue Apr 28, 2014
Merged
bors added a commit that referenced this issue Apr 30, 2014
@bors
auto merge of #13776 : adrientetar/rust/rustdoc-fix, r=brson
cbf1131 
- 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
@steveklabnik
Copy link
Member

I believe that all of these have been addressed with @adrientetar 's PRs. Please open more issues if not!

arcnmx pushed a commit to arcnmx/rust that referenced this issue Jan 9, 2023
@bors
Auto merge of rust-lang#13804 - WaffleLapkin:inlay_hint_mods, r=Veykril
9dfb9df 
Split inlay hints into modules per hint type

I think this makes the code a lot easier to maintain.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@steveklabnik @lifthrasiir @adrientetar