rust-lang / rust-lang/rust-analyzer

documentation tooltip links to nonsensical docs.rs page

Open
#10,646 2 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-doc-comments A-hover A-ide C-feature S-actionable
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

Given this code:

struct Foo;

/// Like [`Foo`] but better.
struct Bar;

fn main() {
    let x = Ba$0r;
}

A hover produces:

image

Foo when clicked, links to: https://docs.rs/rust_playground/*/rust_playground/struct.Foo.html

I think it should behave like these links:

image
and just navigate you to the relevant item in the editor.

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

Reproduce the Rust example and inspect the hover tooltip and its Foo link. Trace how the documentation link is generated; done means clicking Foo navigates to the relevant item in the editor instead of the nonsensical docs.rs page.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.