frontend: change logic of when doc links are shown in search results #9475
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
The crate version page uses a fallback to handle crates that don't define `documentation` keys in their manifests: if docs.rs has documentation for that crate version, that those docs are used. The search results do not implement the same logic, so crates that don't have `documentation` keys don't get the handy documentation link in the crate row. This copies the logic from the version model into the crate model, using the default crate version as the version to look for on docs.rs. I strongly suspect there is a better way to do this than copying a bunch of code, and would welcome suggestions from those more familiar with Ember. This would eventually fix rust-lang#1484.
|
Doesn't this run into the issue of hammering docs.rs mentioned in #1484 (comment) ? |
|
yeah, this would create an N+1 query situation towards the docs.rs API. I'm not sure whether that's actually desirable... slightly tangential: I'm not sure either whether we should really show these doc links in the search results at all. e.g. https://lib.rs/search?q=serde has a more concise view of search results which IMHO is better than ours |
Turbo87
added
C-enhancement ✨
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.
The crate version page uses a fallback to handle crates that don't define
documentationkeys in their manifests: if docs.rs has documentation for that crate version, that those docs are used.The search results do not implement the same logic, so crates that don't have
documentationkeys don't get the handy documentation link in the crate row.This copies the logic from the version model into the crate model, using the default crate version as the version to look for on docs.rs.
I strongly suspect there is a better way to do this than copying a bunch of code, and would welcome suggestions from those more familiar with Ember.
This would eventually fix #1484.