rust-lang / rust-lang/rust-analyzer
Add "Why does Rust Analyzer use so much RAM and CPU?" to manual
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
https://github.com/rust-lang/rust-analyzer/issues/11325 might not cover everything that should be in such a chapter/section, but has an excellent title at least.
For content, I'd want to see information about what features tend to eat lots of RAM or CPU, how to measure it (if rust-analyzer doesn't die immediately), and suggestions on how to deal with this (disabling features, tuning limits, rearranging code, reducing macro output size, attempting to redesign aspects of rust-analyzer, or any other thing).
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 the linked issue rust-lang/rust-analyzer#11325 and locating the relevant section of the rust-analyzer manual. Document resource-intensive features, ways to measure RAM and CPU use, and practical mitigations; the work is done when the manual has a useful, complete chapter or section covering those topics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100