rust-lang / rust-lang/rust-analyzer
Add `cfg(rust_analyzer)` to docs book?
Open
Nobody has claimed this yet.
C-feature
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
I noticed that rust-analyzer handles cfg(rust_analyzer). Can we explain this in the documentation?
If possible, should we add it to the cargo? https://github.com/rust-lang/cargo/issues/16310
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 locating the docs book section that explains conditional compilation and review how it should describe cfg(rust_analyzer). Check the linked Cargo issue before deciding whether Cargo documentation is in scope; done means the rust-analyzer behavior and any Cargo status are clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100