rust-lang / rust-lang/rust-analyzer
Add tags `local`/`global`/`client` to config docs
Open
Nobody has claimed this yet.
A-config
C-feature
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
#17058 will split configs into these three different classes, yet right now the only way for a user to know to which config type a config belongs is by checking the source code. In short, generated_config.adoc must be adapted once the mentioned PR has been merged.
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
After #17058 is merged, open generated_config.adoc and review the documented configs against the new local, global, and client classes. Use the source code where needed to identify each config type, then add the corresponding tags and verify that the documentation clearly exposes the classification.
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
- 55/100