Reintroduce spotlight/"important traits" feature by Manishearth · Pull Request #74111 · rust-lang/rust

Sorry but I'm still not in favor of this feature and the @rust-lang/rustdoc already voted to opt it out. It has been proven to be more noise than useful (and not only from the twitter thread linked in the issue).

Mark-Simulacrum · 2020-07-06T21:40:12Z

I feel like closing this is premature. I don't see an FCP for removal anywhere, and based on @kinnison's comments on #73785 there's not really consensus amongst T-rustdoc that this isn't a good feature to have, rather, it was deemed "not horrible" to remove given your (strong?) opinion, especially because reverting that decision was relatively easy.

I for one continue to miss this feature pretty much every time I'm working with some non-obvious iterator where knowing the item type is super useful. The same goes for interactions with futures libraries, where it's particularly painful to figure out the item type.

If the problem is the choice of trait to display, IMO, we can require that the trait must be annotated with something like #[rustdoc::notable_trait] or whatever (fine to make unstable for now).

I don't think I've seen any discussion of why you're against it beyond it being too much information -- but the key point to me is that this is just enough information. I don't usually care about anything except for the Item/Output associated type, I already have a pretty good idea about the methods etc that Iterator and/or FutureExt or so provide.

GuillaumeGomez · 2020-07-06T21:50:29Z

Like I said, this decision doesn't come out of nowhere. It had a few downsides but the main one was simply that users didn't use it (and I don't have this information only from the twitter thread like I said). We kept this feature around for a while and whenever I talked about it, people just realized it existed and didn't find it useful in most cases and often they just didn't understand what it was used for.

The other big issue was the amount of JS code needed for it. Maintaining something used by a very small minority of users is not worth it considering how much time it takes me to maintain them. Also, "important traits" or whatever the name still remains a very anecdotal information.

Anyway, like I said, the rustdoc team opted it. If you want to debate about this feature, we can do it in an issue so no one loses more time than necessary writing code to get it closed like this (I really feel bad about that because of the time @Manishearth took to write this PR...). But as is, this is a no-go.

GuillaumeGomez · 2020-07-06T23:11:04Z

So after discussion with @Manishearth, we came to this conclusion: a few more steps will be required to reach a good enough level for everyone to be able to enjoy this feature, and in order to do so, we'll do it in multiple steps (asking for feedbacks along the road).

For the current PR, I propose the following changes:

Please reword it to make it more clear.
No popup, just a hover (eventually click) event handling for the text to appear (like a bubble, not a popup). The click handling is for the mobile devices.
If possible, as little JS as possible (some CSS would allow us to handle the bubble easily on hover/click through a class).

Manishearth · 2020-07-07T00:31:01Z

@GuillaumeGomez made all the changes. The JS now used by this feature is minimal.

This makes the spotlight show on hover instead of click. Clicks can be used to persist it, which is also what's used on mobile.

bors · 2020-07-07T05:23:40Z

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

GuillaumeGomez · 2020-07-15T15:29:40Z

 }());

+ function showImportantTraits(content) {
+ let list = content.classList


What is list used for?

GuillaumeGomez · 2020-07-15T15:29:52Z

 }());

+ function showImportantTraits(content) {
+ let list = content.classList


Missing ; too. :)

GuillaumeGomez · 2020-07-15T15:30:59Z

 });
 }());

+ function showImportantTraits(content) {


Actually, this function is never used. Please remove it.

GuillaumeGomez · 2020-07-15T15:31:32Z

+
+ onEachLazy(document.getElementsByClassName("important-traits"), function(e) {
+ e.onclick = function() {
+ e.getElementsByClassName('important-traits-tooltiptext')[0].classList.toggle("force-tooltip")


I think it's better to use either this or event.target in here (event would be the first argument given to onclick).

Wouldn't that just be e anyway?

I'm not too confident about the variable capture process in JS so I prefer to minimize it as much as possible.

GuillaumeGomez · 2020-07-15T15:31:45Z

+
+ onEachLazy(document.getElementsByClassName("important-traits"), function(e) {
+ e.onclick = function() {
+ e.getElementsByClassName('important-traits-tooltiptext')[0].classList.toggle("force-tooltip")


Also missing ;.

GuillaumeGomez · 2020-07-15T15:33:26Z

You'll need to add the CSS changes inside the newly added ayu theme too.

GuillaumeGomez · 2020-07-15T15:33:55Z

 function handleEscape(ev) {
 var help = getHelpElement();
 var search = getSearchElement();
+ hideModal();


Why did you add the hideModal calls BTW?

Didn't intend to. Will fix.

GuillaumeGomez · 2020-07-15T15:35:11Z

 }

+.important-traits-tooltiptext {
+	background-color: #111 !important;


Do you really need !important? Generally, just giving a more precise selector allows to override things without needing them.

Yes, because we're just overriding the same declaration in the themeless version. I added a decl in the themeless version with the intent of having okayish defaults.

Maybe remove it from the themeless version then? We always have themes after all...

Manishearth · 2020-07-15T15:58:58Z

Everything addressed except for the Ayu thing. I'll add that shortly after trying out my rebased build

Manishearth · 2020-07-15T16:03:41Z

Hmm, i've updated my branch but the PR seems frozen https://github.com/Manishearth/rust/tree/re-spotlight

Manishearth · 2020-07-15T16:05:31Z

Reopened as #74370

…meGomez Reintroduce spotlight / "important traits" feature (Reopened version of rust-lang#74111 because Github is broken, see discussion there) Fixesrust-lang#73785 This PR reintroduces the "spotlight" ("important traits") feature. A couple changes have been made: As there were concerns about its visibility, it has been moved to be next to the return type, as opposed to being on the side. It also no longer produces a modal, it shows the traits on hover, and it can be clicked on to pin the hover bubble. ![image](https://user-images.githubusercontent.com/1617736/86674555-a82d2600-bfad-11ea-9a4a-a1a9ffd66ae5.png) ![image](https://user-images.githubusercontent.com/1617736/86674533-a1061800-bfad-11ea-9e8a-c62ad86ed0d7.png) It also works fine on mobile: ![image](https://user-images.githubusercontent.com/1617736/86674638-bda25000-bfad-11ea-8d8d-1798b608923e.png)

Manishearth added 2 commits July 6, 2020 13:38

Revert "Remove "important traits" feature"
1cff03d
This reverts commit 1244ced.

Revert "Remove spotlight usage"
7539451
This reverts commit 13c6d58.

rust-highfive assigned steveklabnik Jul 6, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 6, 2020

rust-highfive assigned kinnison and unassigned steveklabnik Jul 6, 2020

Manishearth mentioned this pull request Jul 6, 2020
Reintroduce spotlight feature ("important traits") #73785
Closed

GuillaumeGomez closed this Jul 6, 2020

GuillaumeGomez reopened this Jul 6, 2020

Move spotlight next to the return type
f2b7e83

Manishearth force-pushed the re-spotlight branch from a01e1cc to 378136dCompare July 7, 2020 00:19

Manishearth changed the title ~~Reintroduce spotlight, move next to the return type~~Reintroduce spotlight/"important traits" featureJul 7, 2020

Manishearth force-pushed the re-spotlight branch from 378136d to f21c691Compare July 7, 2020 00:30

Manishearth force-pushed the re-spotlight branch from f21c691 to 8b9557fCompare July 7, 2020 00:32

Make spotlight show on hover
b65fa84
This makes the spotlight show on hover instead of click. Clicks can be used to persist it, which is also what's used on mobile.

Manishearth force-pushed the re-spotlight branch from 8b9557f to b65fa84Compare July 7, 2020 00:36

GuillaumeGomez reviewed Jul 15, 2020
View reviewed changes

Manishearth closed this Jul 15, 2020

Manishearth mentioned this pull request Jul 15, 2020
Reintroduce spotlight / "important traits" feature #74370
Merged

Uh oh!

Uh oh!

Conversation

Manishearth commented Jul 6, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Jul 6, 2020

Uh oh!

rust-highfive commented Jul 6, 2020

Uh oh!

Manishearth commented Jul 6, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GuillaumeGomez commented Jul 6, 2020

Uh oh!

Mark-Simulacrum commented Jul 6, 2020

Uh oh!

GuillaumeGomez commented Jul 6, 2020

Uh oh!

GuillaumeGomez commented Jul 6, 2020

Uh oh!

Manishearth commented Jul 7, 2020

Uh oh!

bors commented Jul 7, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Jul 15, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Manishearth commented Jul 15, 2020

Uh oh!

Manishearth commented Jul 15, 2020

Uh oh!

Manishearth commented Jul 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Manishearth commented Jul 6, 2020•
edited
Loading

Manishearth commented Jul 6, 2020•
edited
Loading