tweak search result order
Open
Nobody has claimed this yet.
A-rustdoc-search
C-enhancement
T-rustdoc
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
a search for Result::Ok will show first the method result::Result::ok, then several aliases such as io::Result::Ok, then result::Result::Ok, then more aliases.
there are two changes required to present a more logical order:
- prioritize variants over methods (inspired by this discussion)
- de-prioritize type aliases and variants/fields thereof.
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 reproducing the Result::Ok query in the linked nightly std index and read the referenced discussion in rust-lang/rust#132569. The work is done when variants rank before methods and type aliases, including their variants or fields, are de-prioritized in the search results.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100