rustdoc-search: show type signature on type-driven SERP #124544
+1,293
−563
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
rustbot has assigned @GuillaumeGomez. Use |
rustbot
added
S-waiting-on-review
|
I'll let @aDotInTheVoid confirms it looks good before reviewing the code. |
This comment has been minimized.
This comment has been minimized.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
888ee4d
to
681f0c2
Compare
This comment has been minimized.
This comment has been minimized.
|
Some changes occurred in GUI tests. Some changes occurred in HTML/CSS/JS. cc @GuillaumeGomez, @jsha |
|
☔ The latest upstream changes (presumably #126144) made this pull request unmergeable. Please resolve the merge conflicts. |
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
0feb8de
to
ee3ee04
Compare
This comment has been minimized.
This comment has been minimized.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
ee3ee04
to
e350324
Compare
This comment has been minimized.
This comment has been minimized.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
e350324
to
f817d33
Compare
This comment has been minimized.
This comment has been minimized.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
f817d33
to
801c978
Compare
|
Having played around with this, I really like it. I think the searching side seems really solid and have some small nitpicks on the UI side. Feel free to disregard them, as I'm not great at this, and others on the rustdoc team have put alot more thaught into our UI than I have. In rough order of importance:
Thanks again for working on this, I'm really excited about having this! |
| @@ -2743,17 +2748,19 @@ Original by Dempfi (https://github.com/dempfi/ayu) | |||
| border-right: 1px solid #ffb44c; | |||
| } | |||
|
|
|||
| :root[data-theme="ayu"] .search-results a:hover, | |||
| :root[data-theme="ayu"] .search-results a:focus { | |||
| :root[data-theme="ayu"] .search-results li:hover > a, | |||
There was a problem hiding this comment.
Having this special case for the ayu theme is really not great, we should try to either make a new variable or "fix" the ayu theme at some point (not for this PR).
|
Please also add a test for clicking on the One final thought: I think, from what I understood of the code, that maybe it could be simplified to handle the notable trait part. I'll need to come back to this to ensure I didn't miss something obvious. |
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
d476d19
to
8fe7dd4
Compare
|
Pushed changes to address nits:
|
notriddle
added a commit
to notriddle/rust
that referenced
this pull request
Jul 11, 2024
This commit is a response to feedback on the displayed type signatures results, by making type params looser and generics act stricter. Type params are loosened by allowing a single function type param to match multiple query params. In other words, the relationship is loosened to N:1 instead of the older 1:1 rule. This change also allows a type param to be unboxed in one spot and matched in another. Generics are tightened by making order significant. This means `Vec<Allocator>` now matches only with a true vector of allocators, instead of matching the second type param. It also makes unboxing within generics stricter, so `Result<A, B>` only matches if `B` is in the error type and `A` is in the success type. The top level of the function search is unaffected. Find the discussion on: * <https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.202024-07-08/near/449965149> * <rust-lang#124544 (comment)>
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
b051735
to
e0c3562
Compare
This comment has been minimized.
This comment has been minimized.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
e0c3562
to
f8b3e1a
Compare
notriddle
added a commit
to notriddle/rust
that referenced
this pull request
Jul 25, 2024
This commit is a response to feedback on the displayed type signatures results, by making type params looser and generics act stricter. Type params are loosened by allowing a single function type param to match multiple query params. In other words, the relationship is loosened to N:1 instead of the older 1:1 rule. This change also allows a type param to be unboxed in one spot and matched in another. Generics are tightened by making order significant. This means `Vec<Allocator>` now matches only with a true vector of allocators, instead of matching the second type param. It also makes unboxing within generics stricter, so `Result<A, B>` only matches if `B` is in the error type and `A` is in the success type. The top level of the function search is unaffected. Find the discussion on: * <https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.202024-07-08/near/449965149> * <rust-lang#124544 (comment)>
|
☔ The latest upstream changes (presumably #128253) made this pull request unmergeable. Please resolve the merge conflicts. |
In order to show the type signature, this has to be stored somewhere.
This reduces code size while still matching the common case for plain, concrete types.
This fixes the "About This Result" page so that it shows the case of type parameters in the query.
Essentially, the unifier only adds generics to a parameter when a part of its where clause is highlighted. To make that work, the formatter can ignore the empties.
Make it a fixed width font, fix the trait bound format, and don't show `T is T` maps or unhighlighted bounds.
This commit tweaks the format to reduce its size and merges it into the index, which should reduce the amount of network traffic overall.
Co-authored-by: Guillaume Gomez <guillaume1.gomez@gmail.com>
This is a GUI affordance that I basically copied from DuckDuckGo. You can make text selections starting in the description by dragging the mouse, even though clicking on the description opens the page.
notriddle
force-pushed
the
notriddle/type-signature-v2
branch
from
f8b3e1a
to
b90d43d
Compare
notriddle
added a commit
to notriddle/rust
that referenced
this pull request
Jul 27, 2024
This commit is a response to feedback on the displayed type signatures results, by making type params looser and generics act stricter. Type params are loosened by allowing a single function type param to match multiple query params. In other words, the relationship is loosened to N:1 instead of the older 1:1 rule. This change also allows a type param to be unboxed in one spot and matched in another. Generics are tightened by making order significant. This means `Vec<Allocator>` now matches only with a true vector of allocators, instead of matching the second type param. It also makes unboxing within generics stricter, so `Result<A, B>` only matches if `B` is in the error type and `A` is in the success type. The top level of the function search is unaffected. Find the discussion on: * <https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.202024-07-08/near/449965149> * <rust-lang#124544 (comment)>
notriddle
added a commit
to notriddle/rust
that referenced
this pull request
Aug 13, 2024
This commit is a response to feedback on the displayed type signatures results, by making type params looser and generics act stricter. Type params are loosened by allowing a single function type param to match multiple query params. In other words, the relationship is loosened to N:1 instead of the older 1:1 rule. This change also allows a type param to be unboxed in one spot and matched in another. Generics are tightened by making order significant. This means `Vec<Allocator>` now matches only with a true vector of allocators, instead of matching the second type param. It also makes unboxing within generics stricter, so `Result<A, B>` only matches if `B` is in the error type and `A` is in the success type. The top level of the function search is unaffected. Find the discussion on: * <https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.202024-07-08/near/449965149> * <rust-lang#124544 (comment)>
notriddle
added a commit
to notriddle/rust
that referenced
this pull request
Aug 13, 2024
This commit is a response to feedback on the displayed type signatures results, by making type params looser and generics act stricter. Type params are loosened by allowing a single function type param to match multiple query params. In other words, the relationship is loosened to N:1 instead of the older 1:1 rule. This change also allows a type param to be unboxed in one spot and matched in another. Generics are tightened by making order significant. This means `Vec<Allocator>` now matches only with a true vector of allocators, instead of matching the second type param. It also makes unboxing within generics stricter, so `Result<A, B>` only matches if `B` is in the error type and `A` is in the success type. The top level of the function search is unaffected. Find the discussion on: * <https://rust-lang.zulipchat.com/#narrow/stream/393423-t-rustdoc.2Fmeetings/topic/meeting.202024-07-08/near/449965149> * <rust-lang#124544 (comment)>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a rewrite of #117112, based on feedback by @aDotInTheVoid.
Part of rust-lang/rust-project-goals#112
Preview
Preview page:
Screenshots:
Rationale
Since the point of this feature is to answer the question "why this a match," it's important that it communicates a few things:
This change doesn't touch deduplication. That logic needs some adjusting, but is separate enough from this problem to be done in a different PR.
How it works
A particular source of complexity in this PR is caused by storing the names of type parameters. Since this data is only needed after the results come up, loading them gets delayed until after the search is done, so that they can be loaded at the same time as the descriptions.
Future possibilities
This PR is based on #124148. This feature benefits from the type signature index itself being accurate, so we really kinda need full support for Rust's type grammar.