Search over generic types in docs #45673

GuillaumeGomez · 2017-10-31T22:28:50Z

This is what I was talking about @QuietMisdreavus. Now we have generics.

Waiting for #45617 to get merged.

rust-highfive · 2017-10-31T22:29:00Z

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

GuillaumeGomez · 2017-11-02T00:03:32Z

It's now fully functional. You can look for type as generic parameters and look for types such as "Result". A little screenshot of the last commit:

QuietMisdreavus · 2017-11-03T23:02:51Z

Shouldn't some of these be in the "As return value" instead?

I would expect the "As return value" tab to prioritize perfect matches of one of the type variables over ones that have no type variables but have a low lev score:

For public perusal, i have a rendering of the current PR here.

QuietMisdreavus · 2017-11-06T23:30:33Z

Now that #45617 is merged, can you rebase on top of it to factor out the commits that were taken from there?

projektir · 2017-11-07T00:00:28Z

src/librustdoc/html/static/main.js

I think numElements would be a better name for this.

projektir · 2017-11-07T00:07:15Z

src/librustdoc/html/static/main.js

I feel that this would be better off on the same line.

I agree, only issue: line > 100 columns. :)

projektir · 2017-11-07T00:37:48Z

src/librustdoc/html/static/main.js

The check is literalSearch === true in other parts of the code.

projektir · 2017-11-07T00:38:15Z

src/librustdoc/html/static/main.js

shepmaster · 2017-11-11T01:12:40Z

Ping from triage — @GuillaumeGomez will you be able to address some of the feedback you've received?

GuillaumeGomez · 2017-11-11T11:15:42Z

I'll be able to address all of them.

bors · 2017-11-11T15:50:29Z

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

GuillaumeGomez · 2017-11-12T00:11:03Z

Updated.

QuietMisdreavus · 2017-11-12T03:14:24Z

This still seems to have a problem of taking all the items that should be in "As parameters" and putting them into "Types/modules" instead.

Your PR:

Current nightly:

GuillaumeGomez · 2017-11-12T11:38:01Z

Hum, still not good then... Let's see what's happening.

GuillaumeGomez · 2017-11-12T12:19:52Z

Ok, the mystery has been solved: I forgot to add the results into the tab. We're good now. :)

QuietMisdreavus

Home stretch! With that last change, this totally works. Just one last nit and i'll be ready to call it good.

QuietMisdreavus · 2017-11-12T14:20:49Z

src/librustdoc/html/render.rs

Can't this just reuse Type::generics rather than copying it out? That way, if other Types support generics, both this and the "document impls when the type appears in the traits generics" benefit.

QuietMisdreavus · 2017-11-12T20:52:10Z

Excellent! r=me pending travis.

Thanks so much for doing this! This makes the extended search tabs much nicer.

GuillaumeGomez · 2017-11-12T22:27:26Z

@bors: r=QuietMisdreavus

bors · 2017-11-12T22:27:27Z

📌 Commit 0e4c829 has been approved by QuietMisdreavus

bors · 2017-11-13T06:54:30Z

⌛ Testing commit 0e4c829 with merge c8c1424...

@QuietMisdreavus

…QuietMisdreavus Search over generic types in docs This is what I was talking about @QuietMisdreavus. Now we have generics. Waiting for #45617 to get merged.

bors · 2017-11-13T09:12:55Z

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing c8c1424 to master...

rust-highfive assigned QuietMisdreavus Oct 31, 2017

kennytm added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 1, 2017

GuillaumeGomez mentioned this pull request Nov 1, 2017

Search fixes #45617

Merged

GuillaumeGomez force-pushed the rustdoc-type-search-generic branch 3 times, most recently from fc2fb75 to 6f88227 Compare November 1, 2017 23:54

GuillaumeGomez changed the title ~~[WIP] Only search over generic types in docs~~ Only search over generic types in docs Nov 3, 2017

GuillaumeGomez changed the title ~~Only search over generic types in docs~~ Search over generic types in docs Nov 3, 2017

projektir reviewed Nov 7, 2017

View reviewed changes

src/librustdoc/html/static/main.js Outdated

Copy link

Contributor

projektir Nov 7, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think numElements would be a better name for this.

projektir reviewed Nov 7, 2017

View reviewed changes

src/librustdoc/html/static/main.js Outdated

Copy link

Contributor

projektir Nov 7, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

shepmaster 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-review Status: Awaiting review from the assignee but also interested parties. labels Nov 11, 2017

GuillaumeGomez force-pushed the rustdoc-type-search-generic branch from 597a82f to 942a4e9 Compare November 11, 2017 22:26

QuietMisdreavus reviewed Nov 12, 2017

View reviewed changes

GuillaumeGomez added 3 commits November 12, 2017 21:38

Generate generics on search-index

2db6ce6

JS big updates

c3207ba

Add elements count in tab search title

c96be6f

GuillaumeGomez added 3 commits November 12, 2017 21:38

Big JS optimization

6514f44

Improve result output

5c5ab0d

Add "As parameters" items as well

0e4c829

GuillaumeGomez force-pushed the rustdoc-type-search-generic branch from 2246728 to 0e4c829 Compare November 12, 2017 20:38

bors merged commit 0e4c829 into rust-lang:master Nov 13, 2017

bors mentioned this pull request Nov 13, 2017

Change "Types/modules" title of search tab to be more accurate #45898

Merged

GuillaumeGomez deleted the rustdoc-type-search-generic branch November 13, 2017 09:35

Search over generic types in docs #45673

Search over generic types in docs #45673

Uh oh!

Conversation

GuillaumeGomez commented Oct 31, 2017

Uh oh!

rust-highfive commented Oct 31, 2017

Uh oh!

GuillaumeGomez commented Nov 2, 2017

Uh oh!

QuietMisdreavus commented Nov 3, 2017

Uh oh!

QuietMisdreavus commented Nov 6, 2017

Uh oh!

projektir Nov 7, 2017

Choose a reason for hiding this comment

Uh oh!

projektir Nov 7, 2017

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Nov 7, 2017

Choose a reason for hiding this comment

Uh oh!

projektir Nov 7, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

projektir Nov 7, 2017

Choose a reason for hiding this comment

Uh oh!

shepmaster commented Nov 11, 2017

Uh oh!

GuillaumeGomez commented Nov 11, 2017

Uh oh!

bors commented Nov 11, 2017

Uh oh!

GuillaumeGomez commented Nov 12, 2017

Uh oh!

QuietMisdreavus commented Nov 12, 2017

Uh oh!

GuillaumeGomez commented Nov 12, 2017

Uh oh!

GuillaumeGomez commented Nov 12, 2017

Uh oh!

QuietMisdreavus left a comment

Choose a reason for hiding this comment

Uh oh!

QuietMisdreavus Nov 12, 2017

Choose a reason for hiding this comment

Uh oh!

QuietMisdreavus commented Nov 12, 2017

Uh oh!

GuillaumeGomez commented Nov 12, 2017

Uh oh!

bors commented Nov 12, 2017

Uh oh!

bors commented Nov 13, 2017

Uh oh!

bors commented Nov 13, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

projektir Nov 7, 2017 •

edited

Loading