rust-lang / rust-lang/rust-analyzer
Better support for regular comments
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
In the context of unsafe, it's advised to add // SAFETY: comments, there's even a clippy lint for that.
Those comments are highly important, but their developer experience is sub-par: intra-doc links are not supported by the ide. (cargo test --docs doesn't check those either, but it's a different subject).
I'd like to discuss it that's possible to improve this experience.
Tech breadcrumbs
Disclaimer, I'm not familiar with rust-analyzer inner workings.
It seems around here, we may be able to lower constraints on that step:
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 reading crates/ide/src/goto_definition.rs around line 71 and investigate how // SAFETY: comments are currently treated. Compare the current IDE behavior for intra-doc links in regular comments with the requested experience; done means the desired link support is clearly defined and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100