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

Rustdoc: struct fields are spaced too closely #128260

Open
tgross35 opened this issue Jul 27, 2024 · 3 comments
Open

Rustdoc: struct fields are spaced too closely #128260

tgross35 opened this issue Jul 27, 2024 · 3 comments
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tgross35
Copy link
Contributor

Sample at https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/mir/struct.Body.html:

image

Headings seem too close to the paragraphs around them, enough so that paragraph breaks stand out more than field breaks.

Testing with .structfield { padding-top: 0.8rem; padding-bottom: 0.2rem; }, I think this makes sections stand out better:

image
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Jul 27, 2024
@tgross35 tgross35 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: rustdoc UI (generated HTML) and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jul 27, 2024
@tgross35
Copy link
Contributor Author

If somebody points me in the right direction then I can do this (unless somebody beats me to it, feel free).

@gurry
Copy link
Contributor

gurry commented Jul 27, 2024

I'm no rustdoc expert but this is the template that seems to be rendering the HTML in question: https://github.com/rust-lang/rust/blob/master/src/librustdoc/html/templates/item_union.html

It might also help to just search for "structfield" under src/librustdoc in the repo.

@tgross35
Copy link
Contributor Author

tgross35 commented Jul 27, 2024

Thanks for taking a look - aiui that is indeed where the HTML comes from, but I was less certain about the CSS.

.section-header > a > code {
seems like a reasonable guess, but I just wanted to double check styles aren't applied in JS or something like that (I assume themes are but maybe not layout?).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-rustdoc-ui Area: rustdoc UI (generated HTML) E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. 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

3 participants