rust-lang / rust-lang/rust-analyzer
Allow intra-docs-links to jump to current crate code
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
Currently, when clicking a intra doc link, it opens a browser linking to docs.rs crate page.
When working on a crate which is (not yet / never) publicly published, these links don't work. As a developer I would actually rather jump to the actual code of the mentioned type if it's in my current crate similar as the bottom Go to ExampleType. Alternatively, also list OtherType in the bottom items next to Go to ExampleType.
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 intra-doc link behavior in rust-analyzer for a crate that is not published, then inspect the code handling links to docs.rs and the existing “Go to ExampleType” navigation. Confirm whether the intended result is navigation to matching code in the current crate or an additional bottom item, and consider the work done when current-crate types can be reached from these links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100