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.

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

rustdoc: Impl block docs are indented more than the child items, so they appear to not apply to the whole block #131704

Closed
camelid opened this issue Oct 14, 2024 · 3 comments · Fixed by #131718
Closed

rustdoc: Impl block docs are indented more than the child items, so they appear to not apply to the whole block #131704

camelid opened this issue Oct 14, 2024 · 3 comments · Fixed by #131718
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@camelid
Copy link
Member

camelid commented Oct 14, 2024

This screenshot from #130612 exemplifies the issue:

Image

cc @GuillaumeGomez
cc https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/2024-10-14/near/476842302
@camelid camelid added A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Oct 14, 2024
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Oct 14, 2024
@camelid camelid removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Oct 14, 2024
@GuillaumeGomez
Copy link
Member

Thanks! Gonna take a look at it tomorrow.

@lolbinarycat
Copy link
Contributor

there's ~two possible solutions:

  1. decrease the indentation of the documentation
  2. increase the indentation of child fn items

personally, i would be in favor of doing a combination of the two.

@GuillaumeGomez
Copy link
Member

It's indeed a bit weird that impl items have the same left margin level as their parent. Thanks for pointing it out!

@GuillaumeGomez GuillaumeGomez mentioned this issue Oct 14, 2024
Merged
@bors bors closed this as completed in f46ed97 Nov 29, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Nov 29, 2024
@rust-timer
Unrolled build for rust-lang#131718
f0d88b8 
Rollup merge of rust-lang#131718 - GuillaumeGomez:impl-items-indent, r=rustdoc

[rustdoc] Change impl items indent

Fixes rust-lang#131704.

| before | after |
|-|-|
| ![image](https://github.com/user-attachments/assets/67679827-6aef-4bdb-93dd-e1a4784566b3) | ![image](https://github.com/user-attachments/assets/8a0e9fbc-794a-4b98-abc6-bbbe178736b1) |

Can be tested [here](https://rustdoc.crud.net/imperio/impl-items-indent/bar/struct.Bar.html).

r? `@notriddle`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[rustdoc] Change impl items indent GuillaumeGomez/rust
4 participants
@GuillaumeGomez @lolbinarycat @camelid @rustbot