Allow restricting search results to come from a subset of crates
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
When docs are built for a set of crates (e.g. https://doc.rust-lang.org/nightly/nightly-rustc/), it's easy to find yourself looking at a wide collection of crates.
AFAIK there's currently no way to restrict searches from a subset of crates. The dropdown for filtering crates is a single-choice dropdown. I run into this quite often, in that I usually have a vague idea of which compiler crates the thing I'm looking for is in, but I do not know exactly which compiler crate. It would be very helpful to me if it's possible to filter on multiple crates.
Apologies if this has been brought up before, I couldn't find a similar issue in the issue tracker based on naive searches.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the rustdoc crate-filter dropdown and the search implementation used by generated documentation. Trace how the current single-crate filter reaches query handling, then define completion as allowing multiple selected crates and returning results only from that subset. Add or update coverage for multi-crate filtering if the relevant tests are found.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100