rust-lang / rust-lang/rust

rustdoc search: trait methods should not show the same as inherent methods

Open
#132,622 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-search C-discussion T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

did a search for "unchecked" and found this confusing snippet:

tuple::get_unchecked_mut

this the SliceIndex trait method.

additionally, perhaps implementations of trait methods should be deprioritized during name-based search?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Reproduce the rustdoc search for "unchecked" and inspect how the SliceIndex trait method is presented alongside inherent methods. Done means trait implementations are distinguished from inherent methods and any intended ranking change is defined and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, search
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.