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

Remove spotlight #69514

Merged
merged 2 commits into from
Mar 10, 2020
Merged

Remove spotlight #69514

merged 2 commits into from
Mar 10, 2020

Conversation

GuillaumeGomez
Copy link
Member

I had a few comments saying that this feature was at best misunderstood or not even used so I decided to organize a poll about on twitter. After 87 votes, the result is very clear: it's not useful. Considering the amount of code we have just to run it, I think it's definitely worth it to remove it.

r? @kinnison

cc @ollie27

@GuillaumeGomez
Copy link
Member Author

Formatting once again...

@Mark-Simulacrum
Copy link
Member

I in fact do use it, though almost exclusively to figure out the item type of a returned iterator.

I'm not sure I would consider such a poll conclusive evidence...

On the other hand, I find clicking through to the relevant type not horrible, so maybe it's not so bad in practice to lose this.

@GuillaumeGomez
Copy link
Member Author

GuillaumeGomez commented Feb 27, 2020

I think it's just too much information. If you want to check what "important trait" a type implements, just click on the type. The number of clicks remains the same but the amount of information is very different.

But thanks for your feedback! :)

@Mark-Simulacrum
Copy link
Member

Well, it is probably the same number of clicks, but I usually need to scroll back and forth to hunt down the iterator impl, whereas it's the "only" thing in the important traits usually.

@Mark-Simulacrum
Copy link
Member

To be clear: I'm fine with this I think, just wanted to raise that we don't do a good enough job IMO about highlighting the item type of the iterator especially with this removed. I would almost want to highlight it directly (i.e., clickless), you almost always want it when you see an iterator in rustdoc.

@ForsakenHarmony
Copy link
Contributor

87 votes, people saying they never used it because they didn't know about it

not sure if that's meaningful evidence for removing it

@kinnison
Copy link
Contributor

kinnison commented Mar 8, 2020

I wonder (a) why one of the checks got stuck, and (b) whether as others have commented, this is the right reaction.

In addition, this doesn't appear to significantly simplify things in the code, so I wonder if this does more than remove a small indicator and small piece of UX behaviour.

What caused you to decide to hold this poll?

@GuillaumeGomez
Copy link
Member Author

Someone for the nth time asked me what what this "important traits" thing and what made those traits "important". I didn't like much this feature from the start since it's very arbitrary and doesn't provide much extra information: you just have to click on the type to see what's implemented on it.

Also, the rustdoc output is already very heavy, this is removing a feature that not much people (to not say no one since I'm sure one or two people are using it...) are using.

@kinnison
Copy link
Contributor

kinnison commented Mar 8, 2020

I think that justification is fair. As Mark said, it'd be useful to work out how to hilight the item type of an iterator (well, more generically, associated types for a trait) but that's not relevant for this change.

I feel like @ForsakenHarmony has a good point that the poll is a very small sample, but then only two people reacted to the PR too. This change is moderately easy to back out if it comes to it, so I'm okay with it.

If you can resolve whatever went wrong with the unfinished check (and re-trigger it if it's possible) then I'm OK to r+ this.

@GuillaumeGomez
Copy link
Member Author

Maybe @pietroalbini knows why or could restart it?

@pietroalbini
Copy link
Member

Restarted it, seems like GitHub missed the update.

@JohnTitor JohnTitor added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 8, 2020
@GuillaumeGomez
Copy link
Member Author

Then let's go!

@bors: r=kinnison

@bors
Copy link
Contributor

bors commented Mar 8, 2020

📌 Commit 13c6d58 has been approved by kinnison

@bors
Copy link
Contributor

bors commented Mar 8, 2020

🌲 The tree is currently closed for pull requests below priority 1000, this pull request will be tested once the tree is reopened

@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-review Status: Awaiting review from the assignee but also interested parties. labels Mar 8, 2020
Centril added a commit to Centril/rust that referenced this pull request Mar 9, 2020
…kinnison

Remove spotlight

I had a few comments saying that this feature was at best misunderstood or not even used so I decided to organize a poll about on [twitter](https://twitter.com/imperioworld_/status/1232769353503956994). After 87 votes, the result is very clear: it's not useful. Considering the amount of code we have just to run it, I think it's definitely worth it to remove it.

r? @kinnison

cc @ollie27
bors added a commit that referenced this pull request Mar 9, 2020
Rollup of 6 pull requests

Successful merges:

 - #69475 (Remove the `no_force` query attribute)
 - #69514 (Remove spotlight)
 - #69677 (rustc_metadata: Give decoder access to whole crate store)
 - #69714 (Make PlaceRef take just one lifetime)
 - #69799 (Allow ZSTs in `AllocRef`)
 - #69836 (Check if output is immediate value)

Failed merges:

r? @ghost
bors added a commit that referenced this pull request Mar 10, 2020
Rollup of 10 pull requests

Successful merges:

 - #69475 (Remove the `no_force` query attribute)
 - #69514 (Remove spotlight)
 - #69677 (rustc_metadata: Give decoder access to whole crate store)
 - #69714 (Make PlaceRef take just one lifetime)
 - #69799 (Allow ZSTs in `AllocRef`)
 - #69817 (test(patterns): add patterns feature tests to borrowck test suite)
 - #69836 (Check if output is immediate value)
 - #69847 (clean up E0393 explanation)
 - #69861 (Add note about localization to std::fmt docs)
 - #69877 (Vec::new is const stable in 1.39 not 1.32)

Failed merges:

r? @ghost
@bors bors merged commit 6115035 into rust-lang:master Mar 10, 2020
@GuillaumeGomez GuillaumeGomez deleted the remove-spotlight branch March 12, 2020 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants