rust-lang / rust-lang/rust-analyzer
Docs for macros are always looked for in remote docs
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
In VSCode, when hovering over a macro call (macro_rules! in this occasion) from some crate and running rust-analyzer: Open Docs, it tries to open the doc from https://docs.rs instead of the local doc I built with cargo doc.
rust-analyzer version: 0.3.1740-standalone (255eed40c 2023-11-17)
rustc version: rustc 1.74.0 (79e9716c9 2023-11-13)
relevant settings: ----
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
Reproduce the VSCode rust-analyzer: Open Docs command on a macro_rules! call from another crate, comparing the local cargo doc output with the docs.rs URL it opens. Trace the documentation lookup entry point and verify that the command opens the matching local documentation when it is available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100