rust-lang / rust-lang/rust-analyzer
Treat intra-doc links as references to be renamed or found
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
It seems that intra-doc links are not counted as references for purposes of Rename or Find All References. It would be useful if they were. (This might count as part of #6168, but the description there seems focused on following links rather than finding them.)
The support for this would also probably make it easy to show broken links as problems immediately (right now, I have to run cargo doc to check for them).
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 tracing how rust-analyzer handles intra-doc links and how Rename and Find All References collect references. Compare the behavior with cargo doc's broken-link checks. Done means intra-doc links participate in rename and reference results, with broken links surfaced immediately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100