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: improve legibility/spacing between multi-paragraph items #130622

Closed
virtualritz opened this issue Sep 20, 2024 · 0 comments · Fixed by #130933
Closed

rustdoc: improve legibility/spacing between multi-paragraph items #130622

virtualritz opened this issue Sep 20, 2024 · 0 comments · Fixed by #130933
Assignees
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Comments

@virtualritz
Copy link

virtualritz commented Sep 20, 2024

See the screenshot below.

As you can see, the first line of the next list item, Interactive Rendering and Scene Edits, Fault Tolerance, etc. is too close to the last paragraph of the previous item.

I.e. spacing between paragraphs under a list item is bigger than spacing between list items. It should be at least the same.

Image

Here is the section of source that generates this:

//! Implements a renderer for the node-based image compositing language API,
//! `nci`.
//!
//! # Design Principles
//!
//! * Simplicity
//!
//!   The interface itself should be simple to understand and use, even if
//!   complex things can be done with it. This simplicity is carried into
//!   everything which derives from the interface.
//!
//! * Interactive Rendering and Scene Edits
//!
//!   Scene edit operations should not be a special case. There should be no
//!   difference between scene description and scene edits. In other words, a
//!   scene description is a series of edits and vice versa.
[...]
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Sep 20, 2024
@fmease fmease added A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Sep 20, 2024
@lolbinarycat lolbinarycat self-assigned this Sep 25, 2024
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Oct 1, 2024
@bors bors closed this as completed in 94a3f96 Oct 1, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this issue Oct 1, 2024
Rollup merge of rust-lang#130933 - lolbinarycat:rustdoc-li-p, r=GuillaumeGomez,notriddle

rustdoc: lists items that contain multiple paragraphs are more clear

fixes rust-lang#130622

before: ![before](https://github.com/user-attachments/assets/fe54d8ee-8a1a-45fc-9434-2737c5c6f4d5)

after:
![after](https://github.com/user-attachments/assets/095be365-1bfc-4001-8664-59bc4125bb05)
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 3, 2024
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 4, 2024
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Oct 4, 2024
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) C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants