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: use javascript to layout notable traits popups #104129

Merged
merged 5 commits into from
Nov 11, 2022
Merged

rustdoc: use javascript to layout notable traits popups #104129

merged 5 commits into from
Nov 11, 2022

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented Nov 7, 2022 •
edited
Loading

@rustbot
Copy link
Collaborator

rustbot commented Nov 7, 2022

r? @jsha

(rustbot has picked a reviewer for you, use r? to override)

@rustbot 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 Nov 7, 2022
@rustbot
Copy link
Collaborator

rustbot commented Nov 7, 2022

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @Folyd, @jsha

@notriddle notriddle force-pushed the notriddle/102576-js-notable-trait branch 6 times, most recently from 424ba55 to 92afac0 Compare November 8, 2022 05:07
@notriddle notriddle force-pushed the notriddle/102576-js-notable-trait branch from 92afac0 to a45151e Compare November 8, 2022 05:47
@GuillaumeGomez
Copy link
Member

It's similar to my approach in #91431. I personally like it. What do you think @Manishearth ?

@Manishearth
Copy link
Member

Seems like a clean way to do this. Not elated about having more JS but I think this is as good a place to have it if any.

@GuillaumeGomez
Copy link
Member

Let's just run a perf check beforehand but otherwise I think it's ready to go.

@bors try @rust-timer queue

@rust-timer

This comment has been minimized.

Sign in to view
@rustbot rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Nov 8, 2022
@bors
Copy link
Contributor

bors commented Nov 8, 2022

⌛ Trying commit a45151e with merge 9e5dcb830b5225cf66838466cf4a2db1058fa8d8...

@bors
Copy link
Contributor

bors commented Nov 8, 2022

☀️ Try build successful - checks-actions
Build commit: 9e5dcb830b5225cf66838466cf4a2db1058fa8d8 (9e5dcb830b5225cf66838466cf4a2db1058fa8d8)

@rust-timer

This comment has been minimized.

Sign in to view
@rust-timer
Copy link
Collaborator

Finished benchmarking commit (9e5dcb830b5225cf66838466cf4a2db1058fa8d8): comparison URL.

Overall result: ❌ regressions - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: +S-waiting-on-review -S-waiting-on-perf -perf-regression

Instruction count

This is a highly reliable metric that was used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 0.6% [0.6%, 0.6%] 1
Improvements ✅
(primary)		 - - 0
Improvements ✅
(secondary)		 - - 0
All ❌✅ (primary) - - 0

Max RSS (memory usage)

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 3.0% [2.7%, 3.5%] 3
Improvements ✅
(primary)		 -1.5% [-2.1%, -1.0%] 2
Improvements ✅
(secondary)		 -4.9% [-4.9%, -4.9%] 1
All ❌✅ (primary) -1.5% [-2.1%, -1.0%] 2

Cycles

Results

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

mean range count
Regressions ❌
(primary)		 - - 0
Regressions ❌
(secondary)		 - - 0
Improvements ✅
(primary)		 -1.2% [-1.2%, -1.2%] 1
Improvements ✅
(secondary)		 -11.7% [-14.3%, -10.2%] 3
All ❌✅ (primary) -1.2% [-1.2%, -1.2%] 1

@rustbot rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Nov 8, 2022
@GuillaumeGomez
Copy link
Member

Seems fine so let's go!

@bors r+ rollup

Manishearth added a commit to Manishearth/rust that referenced this pull request Nov 11, 2022
@Manishearth
Rollup merge of rust-lang#104129 - notriddle:notriddle/102576-js-nota…
206928c 
…ble-trait, r=GuillaumeGomez

rustdoc: use javascript to layout notable traits popups

Fixes rust-lang#102576

Preview: https://notriddle.com/notriddle-rustdoc-demos/102576-js-notable-trait/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200432713-23aa8d49-ba2b-469f-9eab-089e0c174039.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200432735-edd5b53d-e99d-4fc5-9410-8a79e0efdc9d.png)
Manishearth added a commit to Manishearth/rust that referenced this pull request Nov 11, 2022
@Manishearth
Rollup merge of rust-lang#104129 - notriddle:notriddle/102576-js-nota…
16b8651 
…ble-trait, r=GuillaumeGomez

rustdoc: use javascript to layout notable traits popups

Fixes rust-lang#102576

Preview: https://notriddle.com/notriddle-rustdoc-demos/102576-js-notable-trait/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200432713-23aa8d49-ba2b-469f-9eab-089e0c174039.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200432735-edd5b53d-e99d-4fc5-9410-8a79e0efdc9d.png)
@Manishearth Manishearth mentioned this pull request Nov 11, 2022
Closed
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Nov 11, 2022
@Dylan-DPC
Rollup merge of rust-lang#104129 - notriddle:notriddle/102576-js-nota…
1f51fbe 
…ble-trait, r=GuillaumeGomez

rustdoc: use javascript to layout notable traits popups

Fixes rust-lang#102576

Preview: https://notriddle.com/notriddle-rustdoc-demos/102576-js-notable-trait/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200432713-23aa8d49-ba2b-469f-9eab-089e0c174039.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200432735-edd5b53d-e99d-4fc5-9410-8a79e0efdc9d.png)
@Dylan-DPC Dylan-DPC mentioned this pull request Nov 11, 2022
Closed
@notriddle
Copy link
Contributor Author

notriddle commented Nov 11, 2022 •
edited
Loading

@bors r-

failed in rollup

https://github.com/rust-lang-ci/rust/actions/runs/3444420445/jobs/5747010150

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Nov 11, 2022
@notriddle notriddle force-pushed the notriddle/102576-js-notable-trait branch from b3edd70 to 05824cd Compare November 11, 2022 17:02
@Manishearth
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Nov 11, 2022

📌 Commit 05824cd has been approved by Manishearth

It is now in the queue for this repository.

@bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 11, 2022
@Manishearth Manishearth mentioned this pull request Nov 11, 2022
Merged
@Manishearth
Copy link
Member

@bors rollup=iffy

bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 11, 2022
@bors
Auto merge of rust-lang#104293 - Manishearth:rollup-xj92d0k, r=Manish…
42325c5 
…earth

Rollup of 8 pull requests

Successful merges:

 - rust-lang#95292 (Allow specialized const trait impls.)
 - rust-lang#100386 (Make `Sized` coinductive, again)
 - rust-lang#102215 (Implement the `+whole-archive` modifier for `wasm-ld`)
 - rust-lang#103468 (Fix unused lint and parser caring about spaces to won't produce invalid code)
 - rust-lang#103531 (Suggest calling the instance method of the same name when method not found)
 - rust-lang#103960 (piece of diagnostic migrate)
 - rust-lang#104051 (update Miri)
 - rust-lang#104129 (rustdoc: use javascript to layout notable traits popups)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit b74d042 into rust-lang:master Nov 11, 2022
@rustbot rustbot added this to the 1.67.0 milestone Nov 11, 2022
@notriddle notriddle deleted the notriddle/102576-js-notable-trait branch November 11, 2022 23:33
Manishearth added a commit to Manishearth/rust that referenced this pull request Nov 12, 2022
@Manishearth
Rollup merge of rust-lang#104177 - notriddle:notriddle/js-notable-tra…
36d2291 
…it-v2, r=GuillaumeGomez

rustdoc: use consistent "popover" styling for notable traits

Follow-up to rust-lang#104129
Fixes rust-lang#104313.

Preview: https://notriddle.com/notriddle-rustdoc-demos/js-notable-trait-v2/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200710372-d2d992ce-0bdc-4437-9a2e-379a29df09cf.png)

![image](https://user-images.githubusercontent.com/1593513/200711266-e372b176-daa9-45f3-a022-738ef0a77d3c.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200710601-09b3b717-116f-43c6-b14f-34a8b02b33c0.png)

![image](https://user-images.githubusercontent.com/1593513/200711288-3978cdc1-a6c2-47f6-9216-e22e3c1f5bdf.png)
JohnTitor pushed a commit to JohnTitor/rust that referenced this pull request Nov 13, 2022
Rollup merge of rust-lang#104177 - notriddle:notriddle/js-notable-tra…
528b4af 
…it-v2, r=GuillaumeGomez

rustdoc: use consistent "popover" styling for notable traits

Follow-up to rust-lang#104129
Fixes rust-lang#104313.

Preview: https://notriddle.com/notriddle-rustdoc-demos/js-notable-trait-v2/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200710372-d2d992ce-0bdc-4437-9a2e-379a29df09cf.png)

![image](https://user-images.githubusercontent.com/1593513/200711266-e372b176-daa9-45f3-a022-738ef0a77d3c.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200710601-09b3b717-116f-43c6-b14f-34a8b02b33c0.png)

![image](https://user-images.githubusercontent.com/1593513/200711288-3978cdc1-a6c2-47f6-9216-e22e3c1f5bdf.png)
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
@Manishearth
Rollup merge of rust-lang#104129 - notriddle:notriddle/102576-js-nota…
5227295 
…ble-trait, r=Manishearth

rustdoc: use javascript to layout notable traits popups

Fixes rust-lang#102576

Preview: https://notriddle.com/notriddle-rustdoc-demos/102576-js-notable-trait/std/iter/trait.Iterator.html#method.step_by

## Before

![image](https://user-images.githubusercontent.com/1593513/200432713-23aa8d49-ba2b-469f-9eab-089e0c174039.png)

## After

![image](https://user-images.githubusercontent.com/1593513/200432735-edd5b53d-e99d-4fc5-9410-8a79e0efdc9d.png)
Aaron1011 pushed a commit to Aaron1011/rust that referenced this pull request Jan 6, 2023
@bors
Auto merge of rust-lang#104293 - Manishearth:rollup-xj92d0k, r=Manish…
174aef4 
…earth

Rollup of 8 pull requests

Successful merges:

 - rust-lang#95292 (Allow specialized const trait impls.)
 - rust-lang#100386 (Make `Sized` coinductive, again)
 - rust-lang#102215 (Implement the `+whole-archive` modifier for `wasm-ld`)
 - rust-lang#103468 (Fix unused lint and parser caring about spaces to won't produce invalid code)
 - rust-lang#103531 (Suggest calling the instance method of the same name when method not found)
 - rust-lang#103960 (piece of diagnostic migrate)
 - rust-lang#104051 (update Miri)
 - rust-lang#104129 (rustdoc: use javascript to layout notable traits popups)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@notriddle notriddle mentioned this pull request Jun 1, 2023
Merged
notriddle added a commit to notriddle/rust that referenced this pull request Dec 1, 2023
@notriddle
rustdoc: make html checker a bit stricter
a3ef4ed 
The old TODO comment stopped applying when
rust-lang#104129
stopped nesting the notable traits popover within the header.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

@jsha jsha Awaiting requested review from jsha

Assignees

@jsha jsha

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.67.0
Development

Successfully merging this pull request may close these issues.

Notable traits tooltip is laid out underneath subsequent methods
7 participants
@notriddle @rustbot @GuillaumeGomez @Manishearth @rust-timer @bors @jsha