rust-lang / rust-lang/rust-analyzer

Extra brackets intra-doc links in completions

Open
#19,146 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-completion A-doc-comments C-bug
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

Image

/// See [`main`]
fn main() {
    main
}

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 completion behavior using the Rust example in the issue, especially the /// See [main] intra-doc link. Trace the completion rendering path that produces the extra brackets and compare the displayed result with the source link; done when the completion shows the link without duplicated brackets and the behavior is covered by an appropriate test.

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
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.