Unify scraped examples with other code examples #129796

GuillaumeGomez · 2024-08-30T22:17:17Z

This first PR both fixes #129763 but also unifies buttons display for code examples:

You can test it here and here.

I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer).

cc @willcrichton
r? @notriddle

rustbot · 2024-08-30T22:17:26Z

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

GuillaumeGomez · 2024-08-30T22:18:03Z

src/librustdoc/html/templates/source.html

-            {%~ else %}
-                <a href="#{{line|safe}}" id="{{line|safe}}">{{line|safe}}</a>
-            {%~ endif %}
+            {# ~#}


This is to keep the backline character.

notriddle · 2024-08-30T23:20:23Z

I'm happy to have the button-js change as a separate PR. For now, let's just fix the CSS.

GuillaumeGomez · 2024-08-31T13:55:14Z

This spacing is already there in the current version. It's the same for "normal" code examples with line numbers too:

notriddle · 2024-08-31T20:06:34Z

The spacing isn’t the point. The point is the rounded corners.

GuillaumeGomez · 2024-08-31T20:09:59Z

Oooooooh. Totally missed it. Fixing it and adding a test for it as well.

GuillaumeGomez · 2024-08-31T20:29:41Z

So it was actually an already existing bug. Fixed it in this PR anyway. Also updated online docs so you can check the result.

notriddle · 2024-09-01T04:51:23Z

This seems wrong.

GuillaumeGomez · 2024-09-01T12:06:43Z

Oh nice one!

GuillaumeGomez · 2024-09-01T13:02:36Z

Good catch! Fixed this bug as well.

notriddle · 2024-09-01T13:27:21Z

Still comes out wrong on iOS. The code block is below the lines numbers instead of beside it.

GuillaumeGomez · 2024-09-01T16:58:18Z

The screen of the iPhone is really small. ^^'

I needed to reduce the width to less than 400px to finally be able to see the bug. I updated the demo, can you give it another try please?

notriddle · 2024-09-01T17:55:46Z

Corners still seem wrong.

…mples

…ng as expected

GuillaumeGomez · 2024-09-01T18:50:34Z

At least it allowed me to realize that I forgot to add a GUI test for scraped examples code blocks. Now it's done as well.

notriddle · 2024-09-01T19:14:16Z

The corners seem fine now, but I still think it looks a bit weird.

When it’s in collapsed mode, the bottom has a fade-out effect to indicate this. It’s supposed to have it on top, too, but it’s missing.

notriddle · 2024-09-03T21:30:08Z

@bors r+

bors · 2024-09-03T21:30:11Z

📌 Commit 7157f98 has been approved by notriddle

It is now in the queue for this repository.

…, r=notriddle Unify scraped examples with other code examples Fixes rust-lang#129763. This first PR both fixes rust-lang#129763 but also unifies buttons display for code examples: ![image](https://github.com/user-attachments/assets/c8475945-dcc3-4c25-8d7d-1659f85301c8) You can test it [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test.html) and [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test_many.html). I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer). cc `@willcrichton` r? `@notriddle`

…llaumeGomez Rollup of 7 pull requests Successful merges: - rust-lang#127021 (Add target support for RTEMS Arm) - rust-lang#128871 (bypass linker configuration and cross target check for specific commands) - rust-lang#129471 ([rustdoc] Sort impl associated items by kinds and then by appearance) - rust-lang#129529 (Add test to build crates used by r-a on stable) - rust-lang#129706 (Rename dump of coroutine by-move-body to be more consistent, fix ICE in dump_mir) - rust-lang#129796 (Unify scraped examples with other code examples) - rust-lang#129939 (explain why Rvalue::Len still exists) r? `@ghost` `@rustbot` modify labels: rollup

…, r=notriddle Unify scraped examples with other code examples Fixes rust-lang#129763. This first PR both fixes rust-lang#129763 but also unifies buttons display for code examples: ![image](https://github.com/user-attachments/assets/c8475945-dcc3-4c25-8d7d-1659f85301c8) You can test it [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test.html) and [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test_many.html). I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer). cc ``@willcrichton`` r? ``@notriddle``

Rollup of 8 pull requests Successful merges: - rust-lang#101339 (enable -Zrandomize-layout in debug CI builds ) - rust-lang#127021 (Add target support for RTEMS Arm) - rust-lang#128871 (bypass linker configuration and cross target check for specific commands) - rust-lang#129471 ([rustdoc] Sort impl associated items by kinds and then by appearance) - rust-lang#129529 (Add test to build crates used by r-a on stable) - rust-lang#129624 (Adjust `memchr` pinning and run `cargo update`) - rust-lang#129796 (Unify scraped examples with other code examples) - rust-lang#129939 (explain why Rvalue::Len still exists) r? `@ghost` `@rustbot` modify labels: rollup

…, r=notriddle Unify scraped examples with other code examples Fixes rust-lang#129763. This first PR both fixes rust-lang#129763 but also unifies buttons display for code examples: ![image](https://github.com/user-attachments/assets/c8475945-dcc3-4c25-8d7d-1659f85301c8) You can test it [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test.html) and [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test_many.html). I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer). cc `@willcrichton` r? `@notriddle`

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#129529 (Add test to build crates used by r-a on stable) - rust-lang#129624 (Adjust `memchr` pinning and run `cargo update`) - rust-lang#129720 (Simplify DestProp memory management) - rust-lang#129796 (Unify scraped examples with other code examples) - rust-lang#129891 (Do not request sanitizers for naked functions) - rust-lang#129938 (Elaborate on deriving vs implementing `Copy`) Failed merges: - rust-lang#129471 ([rustdoc] Sort impl associated items by kinds and then by appearance) r? `@ghost` `@rustbot` modify labels: rollup

…, r=notriddle Unify scraped examples with other code examples Fixes rust-lang#129763. This first PR both fixes rust-lang#129763 but also unifies buttons display for code examples: ![image](https://github.com/user-attachments/assets/c8475945-dcc3-4c25-8d7d-1659f85301c8) You can test it [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test.html) and [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test_many.html). I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer). cc ``@willcrichton`` r? ``@notriddle``

…iaskrgr Rollup of 8 pull requests Successful merges: - rust-lang#128820 (fix: get llvm type of global val) - rust-lang#129028 (`impl_trait_overcaptures`: Don't worry about uncaptured contravariant lifetimes if they outlive a captured lifetime) - rust-lang#129471 ([rustdoc] Sort impl associated items by kinds and then by appearance) - rust-lang#129706 (Rename dump of coroutine by-move-body to be more consistent, fix ICE in dump_mir) - rust-lang#129720 (Simplify DestProp memory management) - rust-lang#129796 (Unify scraped examples with other code examples) - rust-lang#129938 (Elaborate on deriving vs implementing `Copy`) - rust-lang#129973 (run_make_support: rename `Command::stdin` to `stdin_buf` and add `std{in,out,err}` config helpers) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#129796 - GuillaumeGomez:unify-code-examples, r=notriddle Unify scraped examples with other code examples Fixes rust-lang#129763. This first PR both fixes rust-lang#129763 but also unifies buttons display for code examples: ![image](https://github.com/user-attachments/assets/c8475945-dcc3-4c25-8d7d-1659f85301c8) You can test it [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test.html) and [here](https://rustdoc.crud.net/imperio/unify-code-examples/doc/scrape_examples/fn.test_many.html). I'm planning to send a follow-up to make the buttons generated in JS directly (or I can do it in this PR directly if you prefer). cc ```@willcrichton``` r? ```@notriddle```

…r=notriddle Generate scraped examples buttons in JS Follow-up of rust-lang#129796. To reduce the page size when there are scraped examples, we can generate their buttons in JS since they require JS to work in any case. There should be no changes in display or in functionality. You can test it [here](https://rustdoc.crud.net/imperio/gen-scraped-buttons/doc/scrape_examples/fn.test.html). cc `@willcrichton` r? `@notriddle`

Generate scraped examples buttons in JS Follow-up of rust-lang/rust#129796. To reduce the page size when there are scraped examples, we can generate their buttons in JS since they require JS to work in any case. There should be no changes in display or in functionality. You can test it [here](https://rustdoc.crud.net/imperio/gen-scraped-buttons/doc/scrape_examples/fn.test.html). cc `@willcrichton` r? `@notriddle`

GuillaumeGomez added 2 commits August 31, 2024 00:12

Unify scraped examples with other code examples

0d156f2

Update rustdoc GUI tests

5b75f8a

rustbot assigned notriddle Aug 30, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 30, 2024

GuillaumeGomez commented Aug 30, 2024

View reviewed changes

GuillaumeGomez force-pushed the unify-code-examples branch from e7c2cc1 to fb34b36 Compare September 1, 2024 16:57

GuillaumeGomez force-pushed the unify-code-examples branch from fb34b36 to 6350df4 Compare September 1, 2024 17:02

GuillaumeGomez added 5 commits September 1, 2024 20:49

Fix wrong rounded corners when line numbers are displayed on code exa…

5afc461

…mples

Add GUI tests to ensure that rounded corners on code blocks are worki…

84259ff

…ng as expected

Fix position of scraped examples title on mobile devices

35a7c1b

Add GUI regression test for scraped examples title position on mobile

dd5f7bc

Add missing CSS variables in GUI test for custom-theme.css

4825fb1

GuillaumeGomez force-pushed the unify-code-examples branch from 6350df4 to 4825fb1 Compare September 1, 2024 18:49

GuillaumeGomez added 2 commits September 1, 2024 23:43

Correctly handle code examples buttons position

5a85632

Fix scraped examples background gradient

01d8235

Fix square corners on line numbers when code is collapsed

7157f98

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 Sep 3, 2024

GuillaumeGomez mentioned this pull request Sep 3, 2024

Rollup of 7 pull requests #129946

Closed

tgross35 mentioned this pull request Sep 4, 2024

Rollup of 8 pull requests #129949

Closed

matthiaskrgr mentioned this pull request Sep 5, 2024

Rollup of 6 pull requests #129985

Closed

This was referenced Sep 5, 2024

Rollup of 9 pull requests #129993

Closed

Rollup of 8 pull requests #129994

Merged

bors merged commit 9be97ae into rust-lang:master Sep 5, 2024
6 checks passed

rustbot added this to the 1.83.0 milestone Sep 5, 2024

GuillaumeGomez mentioned this pull request Sep 7, 2024

Generate scraped examples buttons in JS #130069

Merged

GuillaumeGomez deleted the unify-code-examples branch November 29, 2024 13:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify scraped examples with other code examples #129796

Unify scraped examples with other code examples #129796

GuillaumeGomez commented Aug 30, 2024

rustbot commented Aug 30, 2024

GuillaumeGomez Aug 30, 2024

notriddle commented Aug 30, 2024

GuillaumeGomez commented Aug 31, 2024

notriddle commented Aug 31, 2024

GuillaumeGomez commented Aug 31, 2024

GuillaumeGomez commented Aug 31, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

notriddle commented Sep 3, 2024

bors commented Sep 3, 2024

Unify scraped examples with other code examples #129796

Unify scraped examples with other code examples #129796

Conversation

GuillaumeGomez commented Aug 30, 2024

rustbot commented Aug 30, 2024

GuillaumeGomez Aug 30, 2024

Choose a reason for hiding this comment

notriddle commented Aug 30, 2024

GuillaumeGomez commented Aug 31, 2024

notriddle commented Aug 31, 2024

GuillaumeGomez commented Aug 31, 2024

GuillaumeGomez commented Aug 31, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

GuillaumeGomez commented Sep 1, 2024

notriddle commented Sep 1, 2024

notriddle commented Sep 3, 2024

bors commented Sep 3, 2024