Search over generic types in docs #45673

GuillaumeGomez · Oct 31, 2017

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

Waiting for #45617 to get merged.

rust-highfive · Oct 31, 2017

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

GuillaumeGomez · Nov 2, 2017

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 · Nov 3, 2017

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 · Nov 6, 2017

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

projektir · Nov 7, 2017

projektir reviewed Nov 7, 2017

View changes

projektir · Nov 7, 2017

src/librustdoc/html/static/main.js

+                return b;
+            }
+
+            function nbElements(obj) {


I think numElements would be a better name for this.

projektir · Nov 7, 2017

projektir reviewed Nov 7, 2017

View changes

projektir · Nov 7, 2017

src/librustdoc/html/static/main.js

+                    if (obj.generics &&
+                        obj.generics.length >= val.generics.length) {
+                        var elems = obj.generics.slice(0);
+                        for (var y = 0;


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

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

projektir · Nov 7, 2017

projektir reviewed Nov 7, 2017

View changes

projektir · Nov 7, 2017

src/librustdoc/html/static/main.js

                if (obj && obj.type && obj.type.inputs.length > 0) {
                    for (var i = 0; i < obj.type.inputs.length; i++) {
-                        if (obj.type.inputs[i].name === val) {
+                        var tmp = checkType(obj.type.inputs[i], val, literalSearch);
+                        if (literalSearch && tmp === true) {


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

projektir · Nov 7, 2017

projektir reviewed Nov 7, 2017

View changes

projektir · Nov 7, 2017

src/librustdoc/html/static/main.js

+
+                if (obj && obj.type && obj.type.output) {
+                    var tmp = checkType(obj.type.output, val, literalSearch);
+                    if (literalSearch && tmp === true) {


shepmaster · Nov 11, 2017

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

GuillaumeGomez · Nov 11, 2017

I'll be able to address all of them.

bors · Nov 11, 2017

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

GuillaumeGomez · Nov 12, 2017

Updated.

QuietMisdreavus · Nov 12, 2017

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 · Nov 12, 2017

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

GuillaumeGomez · Nov 12, 2017

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

QuietMisdreavus · Nov 12, 2017

QuietMisdreavus reviewed Nov 12, 2017

View changes

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

QuietMisdreavus · Nov 12, 2017

src/librustdoc/html/render.rs

        // FIXME: add all from clean::Type.
        _ => None
    }
 }

+fn get_generics(clean_type: &clean::Type) -> Option<Vec<String>> {
+    match *clean_type {
+        clean::ResolvedPath { ref path, .. } => {


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 · Nov 12, 2017

Excellent! r=me pending travis.

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

GuillaumeGomez · Nov 12, 2017

@bors: r=QuietMisdreavus

bors · Nov 12, 2017

📌 Commit 0e4c829 has been approved by QuietMisdreavus

bors · Nov 13, 2017

⌛️ Testing commit 0e4c829 with merge c8c1424...

bors · Nov 13, 2017

☀️ 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 label Nov 1, 2017

GuillaumeGomez referenced this pull request Nov 1, 2017
Merged
Search fixes #45617

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

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

shepmaster added S-waiting-on-author and removed S-waiting-on-review labels Nov 11, 2017

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

GuillaumeGomez added some commits Oct 31, 2017

Generate generics on search-index

2db6ce6

JS big updates

c3207ba

Add elements count in tab search title

c96be6f

GuillaumeGomez added some commits Nov 11, 2017

Big JS optimization

6514f44

Improve result output

5c5ab0d

Add "As parameters" items as well

Loading status checks…

0e4c829

GuillaumeGomez force-pushed the GuillaumeGomez:rustdoc-type-search-generic branch from 2246728 to 0e4c829 Nov 12, 2017

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

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

homu Test successful
Details

bors referenced this pull request Nov 13, 2017
Merged
Change "Types/modules" title of search tab to be more accurate #45898

GuillaumeGomez deleted the GuillaumeGomez:rustdoc-type-search-generic branch Nov 13, 2017

rust-lang/rust

Join GitHub today

Search over generic types in docs #45673

Conversation

GuillaumeGomez commented Oct 31, 2017

rust-highfive assigned QuietMisdreavus Oct 31, 2017

This comment has been minimized.

rust-highfive commented Oct 31, 2017

kennytm added the S-waiting-on-review label Nov 1, 2017

GuillaumeGomez referenced this pull request Nov 1, 2017

Search fixes #45617

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

This comment has been minimized.

GuillaumeGomez commented Nov 2, 2017

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

This comment has been minimized.

QuietMisdreavus commented Nov 3, 2017

This comment has been minimized.

QuietMisdreavus commented Nov 6, 2017

projektir reviewed Nov 7, 2017 View changes

This comment has been minimized.

projektir Nov 7, 2017

projektir reviewed Nov 7, 2017 View changes

This comment has been minimized.

projektir Nov 7, 2017

This comment has been minimized.

GuillaumeGomez Nov 7, 2017

projektir reviewed Nov 7, 2017 View changes

This comment has been minimized.

projektir Nov 7, 2017 • edited

projektir reviewed Nov 7, 2017 View changes

This comment has been minimized.

projektir Nov 7, 2017

shepmaster added S-waiting-on-author and removed S-waiting-on-review labels Nov 11, 2017

This comment has been minimized.

shepmaster commented Nov 11, 2017

This comment has been minimized.

GuillaumeGomez commented Nov 11, 2017

This comment has been minimized.

bors commented Nov 11, 2017

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

This comment has been minimized.

GuillaumeGomez commented Nov 12, 2017

This comment has been minimized.

QuietMisdreavus commented Nov 12, 2017

This comment has been minimized.

GuillaumeGomez commented Nov 12, 2017

This comment has been minimized.

GuillaumeGomez commented Nov 12, 2017

QuietMisdreavus reviewed Nov 12, 2017 View changes

QuietMisdreavus left a comment

This comment has been minimized.

QuietMisdreavus Nov 12, 2017

GuillaumeGomez added some commits Oct 31, 2017

GuillaumeGomez added some commits Nov 11, 2017

GuillaumeGomez force-pushed the GuillaumeGomez:rustdoc-type-search-generic branch from 2246728 to 0e4c829 Nov 12, 2017

This comment has been minimized.

QuietMisdreavus commented Nov 12, 2017

This comment has been minimized.

GuillaumeGomez commented Nov 12, 2017

This comment has been minimized.

bors commented Nov 12, 2017

This comment has been minimized.

bors commented Nov 13, 2017

bors added a commit that referenced this pull request Nov 13, 2017

This comment has been minimized.

bors commented Nov 13, 2017

Hide details View details bors merged commit 0e4c829 into rust-lang:master Nov 13, 2017 2 checks passed

2 checks passed

bors referenced this pull request Nov 13, 2017

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

GuillaumeGomez deleted the GuillaumeGomez:rustdoc-type-search-generic branch Nov 13, 2017

GuillaumeGomez force-pushed the GuillaumeGomez:rustdoc-type-search-generic branch 3 times, most recently from `fc2fb75` to `6f88227` Nov 1, 2017

projektir reviewed Nov 7, 2017

View changes

projektir reviewed Nov 7, 2017

View changes

projektir reviewed Nov 7, 2017

View changes

projektir Nov 7, 2017 •

edited

projektir reviewed Nov 7, 2017

View changes

GuillaumeGomez force-pushed the GuillaumeGomez:rustdoc-type-search-generic branch from `597a82f` to `942a4e9` Nov 11, 2017

QuietMisdreavus reviewed Nov 12, 2017

View changes

GuillaumeGomez force-pushed the GuillaumeGomez:rustdoc-type-search-generic branch from `2246728` to `0e4c829` Nov 12, 2017

bors merged commit `0e4c829` into rust-lang:master Nov 13, 2017
2 checks passed