Search over generic types in docs #45673
Conversation
|
(rust_highfive has picked a reviewer for you, use r? to override) |
kennytm
added
the
S-waiting-on-review
GuillaumeGomez
force-pushed
the
rustdoc-type-search-generic
branch
3 times, most recently
from
fc2fb75
to
6f88227
Compare
|
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:
|
GuillaumeGomez
changed the title
GuillaumeGomez
changed the title
|
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. |
|
Now that #45617 is merged, can you rebase on top of it to factor out the commits that were taken from there? |
src/librustdoc/html/static/main.js
Outdated
| return b; | ||
| } | ||
|
|
||
| function nbElements(obj) { |
There was a problem hiding this comment.
I think numElements would be a better name for this.
| if (obj.generics && | ||
| obj.generics.length >= val.generics.length) { | ||
| var elems = obj.generics.slice(0); | ||
| for (var y = 0; |
There was a problem hiding this comment.
I feel that this would be better off on the same line.
There was a problem hiding this comment.
I agree, only issue: line > 100 columns. :)
src/librustdoc/html/static/main.js
Outdated
| 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) { |
There was a problem hiding this comment.
The check is literalSearch === true in other parts of the code.
src/librustdoc/html/static/main.js
Outdated
|
|
||
| if (obj && obj.type && obj.type.output) { | ||
| var tmp = checkType(obj.type.output, val, literalSearch); | ||
| if (literalSearch && tmp === true) { |
shepmaster
added
S-waiting-on-author
|
Ping from triage — @GuillaumeGomez will you be able to address some of the feedback you've received? |
|
I'll be able to address all of them. |
|
☔ The latest upstream changes (presumably #45932) made this pull request unmergeable. Please resolve the merge conflicts. |
GuillaumeGomez
force-pushed
the
rustdoc-type-search-generic
branch
from
597a82f
to
942a4e9
Compare
|
Updated. |
|
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:
|
|
Hum, still not good then... Let's see what's happening. |
|
Ok, the mystery has been solved: I forgot to add the results into the tab. We're good now. :) |
src/librustdoc/html/render.rs
Outdated
| // FIXME: add all from clean::Type. | ||
| _ => None | ||
| } | ||
| } | ||
|
|
||
| fn get_generics(clean_type: &clean::Type) -> Option<Vec<String>> { | ||
| match *clean_type { | ||
| clean::ResolvedPath { ref path, .. } => { |
There was a problem hiding this comment.
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.
GuillaumeGomez
force-pushed
the
rustdoc-type-search-generic
branch
from
2246728
to
0e4c829
Compare
|
Excellent! r=me pending travis. Thanks so much for doing this! This makes the extended search tabs much nicer. |
|
@bors: r=QuietMisdreavus |
|
📌 Commit 0e4c829 has been approved by |
…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.
|
☀️ Test successful - status-appveyor, status-travis |
This is what I was talking about @QuietMisdreavus. Now we have generics.
Waiting for #45617 to get merged.