Always display first line of impl blocks even when collapsed #132155

GuillaumeGomez · 2024-10-25T21:12:44Z

Fixes #130612.

It the line is too long, only the beginning will be visible:

Otherwise, it looks like this:

Can be tested here.

r? @notriddle

rustbot · 2024-10-25T21:12:55Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

jieyouxu

This looks cool 💚

tests/rustdoc-gui/src/test_docs/lib.rs

notriddle · 2024-10-28T16:16:08Z

src/librustdoc/html/markdown.rs

@@ -1413,6 +1416,52 @@ impl MarkdownItemInfo<'_> {
    }
 }

+pub(crate) fn markdown_split_summary_and_content(


This should have a comment explaining what it does. Also, it should probably be a method on the Markdown struct? It's basically a different version of to_string.

/// Convert markdown to (summary, remaining) HTML. /// /// - The summary is the first top-level Markdown element (usually a paragraph, but potentially any block). /// - The remaining docs contain everything after the summary.

Good idea for the docs. I don't have an opinion on whether or not it should be a method so I'll just make a method since you seem to favor it. 👍

GuillaumeGomez · 2024-10-28T16:41:03Z

Applied suggestions.

notriddle · 2024-10-28T18:04:09Z

@rfcbot fcp cancel

@rfcbot fcp merge

rfcbot · 2024-10-28T18:04:56Z

@notriddle proposal cancelled.

rfcbot · 2024-10-28T18:04:58Z

Team member @notriddle has proposed to merge this. The next step is review by the rest of the tagged team members:

Concerns:

~~gradient-looks-weird~~ resolved by Always display first line of impl blocks even when collapsed #132155 (comment)
~~table-looks-weird~~ resolved by Always display first line of impl blocks even when collapsed #132155 (comment)

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

camelid · 2024-10-28T18:13:44Z

src/librustdoc/html/static/css/rustdoc.css

+	left: 0;
+	right: 0;
+	pointer-events: none;
+	background: linear-gradient(


I don't love the look of this. It looks a bit out of place compared to the generally clean style of rustdoc. In the case of tables and other things, it seems reasonable to just not show them rather than do a paywall-style blur of everything below the first row.

@rfcbot concern gradient-looks-weird

I see what you mean there. To avoid this, I think you'd want to only have a summary if the first element is a paragraph or header, and then use white-space: nowrap; overflow: hidden; text-overflow: ellipsis;?

Exactly, that sounds good.

I liked the blur effect but text ellipsis is fine too. 😆

Problem with this approach is that the ellipsis only appears if the current sentence is cut:

expanded:

I'll try to check if we can still get the "..." in any case...

I can't figure a way to have an ellipsis which matches these conditions:

Appears whatever the width of the first line.

Appears only if there is hidden content.

With the blur I didn't have these issues, hence why I went for this solution. 😆

If you have an idea, I'd love to hear it!

A few things I thought about: the problem with short sentences is that they don't overflow, and therefore don't generate the ellipsis. However if there is more content, users won't until expanded. So instead I tried to cheat a bit and added a ::after element:

details.toggle:not([open]) > summary .docblock > :first-child { max-width: calc(100% - 1em); overflow: hidden; width: fit-content; white-space: nowrap; position: relative; text-overflow: clip; padding-right: 1em; } details.toggle:not([open]) > summary .docblock > :first-child::after { content: "…"; position: absolute; right: 0; top: 0; background-color: var(--main-background-color); }

However, it never gets displayed correctly on big text as it goes over it or is always stuck to the right side. I was hoping to kinda go around this issue by using padding and was able to. It gives this result:

If you are ok with this result, I can go with it.

notriddle · 2024-10-28T18:19:22Z

@rfcbot concern gradient-looks-weird

#132155 (comment)

GuillaumeGomez · 2024-11-28T16:23:15Z

Fixed merge conflicts.

bors · 2024-12-02T01:22:02Z

☔ The latest upstream changes (presumably #133345) made this pull request unmergeable. Please resolve the merge conflicts.

rfcbot · 2024-12-05T16:45:57Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

This will be merged soon.

GuillaumeGomez · 2024-12-05T22:46:24Z

@bors r=rustdoc

bors · 2024-12-05T22:46:26Z

📌 Commit 854ebe7 has been approved by rustdoc

It is now in the queue for this repository.

…llaumeGomez Rollup of 8 pull requests Successful merges: - rust-lang#132155 (Always display first line of impl blocks even when collapsed) - rust-lang#133256 (CI: use free runners for i686-gnu jobs) - rust-lang#133607 (implement checks for tail calls) - rust-lang#133821 (Replace black with ruff in `tidy`) - rust-lang#133827 (CI: rfl: move job forward to Linux v6.13-rc1) - rust-lang#133910 (Normalize target-cpus.rs stdout test for LLVM changes) - rust-lang#133921 (Adapt codegen tests for NUW inference) - rust-lang#133936 (Avoid fetching the anon const hir node that is already available) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#132155 - GuillaumeGomez:impl-block-doc, r=rustdoc Always display first line of impl blocks even when collapsed Fixes rust-lang#130612. It the line is too long, only the beginning will be visible: ![Screenshot from 2024-10-25 17-21-41](/~https://github.com/user-attachments/assets/dd2d912c-ad55-4410-8195-1d66a0a99ad4) Otherwise, it looks like this: ![image](/~https://github.com/user-attachments/assets/1f40b9e0-2143-4b9d-a4b0-338a0cd740df) Can be tested [here](https://rustdoc.crud.net/imperio/impl-block-doc/foo/struct.ImplDoc.html). r? `@notriddle`

rustbot assigned notriddle Oct 25, 2024

This comment has been minimized.

Sign in to view

GuillaumeGomez force-pushed the impl-block-doc branch from 30f487c to 890fc0d Compare October 25, 2024 22:20

jieyouxu reviewed Oct 26, 2024

View reviewed changes

tests/rustdoc-gui/src/test_docs/lib.rs Show resolved Hide resolved

GuillaumeGomez requested a review from notriddle October 28, 2024 10:16

notriddle reviewed Oct 28, 2024

View reviewed changes

GuillaumeGomez force-pushed the impl-block-doc branch from af1b4fd to 391c707 Compare October 28, 2024 16:40

notriddle added T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 28, 2024

This comment was marked as duplicate.

Sign in to view

rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Oct 28, 2024

notriddle removed the T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. label Oct 28, 2024

rfcbot removed proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Oct 28, 2024

rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Oct 28, 2024

camelid reviewed Oct 28, 2024

View reviewed changes

GuillaumeGomez force-pushed the impl-block-doc branch from 5ff686a to 2555bc1 Compare November 28, 2024 16:22

GuillaumeGomez force-pushed the impl-block-doc branch from 2555bc1 to 55d9f59 Compare December 2, 2024 13:38

This comment has been minimized.

Sign in to view

rfcbot added finished-final-comment-period The final comment period is finished for this PR / Issue. to-announce Announce this issue on triage meeting and removed final-comment-period In the final comment period and will be merged soon unless new substantive objections are raised. labels Dec 5, 2024

rustbot mentioned this pull request Dec 5, 2024

Tracking issue for release notes of #132155: Always display first line of impl blocks even when collapsed #133927

Open

3 tasks

GuillaumeGomez added 8 commits December 5, 2024 22:50

Always display first line of impl blocks even when collapsed

fad5f51

Update browser-ui-test version to 0.18.2

32e6826

Add GUI test for impl block doc display

5d26acc

Update GUI tests

abcd094

Turn markdown_split_summary_and_content into a method of Markdown

6e0dabd

Use text ellipsis instead of bottom blurring

448d9ad

Improve positioning of "..." in collapsed impl block

90feb9a

Update GUI test after rebase

854ebe7

GuillaumeGomez force-pushed the impl-block-doc branch from 1993e55 to 854ebe7 Compare December 5, 2024 21:53

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 5, 2024

GuillaumeGomez mentioned this pull request Dec 5, 2024

Rollup of 8 pull requests #133940

Merged

bors merged commit a424813 into rust-lang:master Dec 6, 2024
6 checks passed

rustbot added this to the 1.85.0 milestone Dec 6, 2024

GuillaumeGomez deleted the impl-block-doc branch December 6, 2024 10:01

crumblingstatue mentioned this pull request Dec 17, 2024

rustdoc: Quick way to collapse all impl blocks #134429

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Always display first line of impl blocks even when collapsed #132155

Always display first line of impl blocks even when collapsed #132155

GuillaumeGomez commented Oct 25, 2024 •

edited

Loading

rustbot commented Oct 25, 2024

This comment has been minimized.

jieyouxu left a comment

notriddle Oct 28, 2024

GuillaumeGomez Oct 28, 2024

GuillaumeGomez commented Oct 28, 2024

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

notriddle commented Oct 28, 2024

rfcbot commented Oct 28, 2024

rfcbot commented Oct 28, 2024 •

edited

Loading

camelid Oct 28, 2024

notriddle Oct 28, 2024

camelid Oct 28, 2024

GuillaumeGomez Oct 29, 2024

GuillaumeGomez Oct 29, 2024

GuillaumeGomez Oct 29, 2024

GuillaumeGomez Oct 29, 2024

notriddle commented Oct 28, 2024

GuillaumeGomez commented Nov 28, 2024

bors commented Dec 2, 2024

This comment has been minimized.

rfcbot commented Dec 5, 2024

GuillaumeGomez commented Dec 5, 2024

bors commented Dec 5, 2024

Always display first line of impl blocks even when collapsed #132155

Always display first line of impl blocks even when collapsed #132155

Conversation

GuillaumeGomez commented Oct 25, 2024 • edited Loading

rustbot commented Oct 25, 2024

This comment has been minimized.

jieyouxu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Oct 28, 2024

This comment was marked as duplicate.

This comment was marked as duplicate.

This comment was marked as duplicate.

notriddle commented Oct 28, 2024

rfcbot commented Oct 28, 2024

rfcbot commented Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

notriddle commented Oct 28, 2024

GuillaumeGomez commented Nov 28, 2024

bors commented Dec 2, 2024

This comment has been minimized.

rfcbot commented Dec 5, 2024

GuillaumeGomez commented Dec 5, 2024

bors commented Dec 5, 2024

GuillaumeGomez commented Oct 25, 2024 •

edited

Loading

rfcbot commented Oct 28, 2024 •

edited

Loading