rust-lang / rust-lang/rust-analyzer

doc: mark out experimental diagnostics to avoid confusion

Open
#18,288 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-diagnostics A-documentation C-enhancement
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

rust-analyzer version: 0.3.2137-standalone (2b750da1a 2024-10-06) [/Users/chenyuwang/.vscode/extensions/rust-lang.rust-analyzer-0.3.2137-darwin-arm64/server/rust-analyzer]

rustc version: -

editor or extension: -

relevant settings: -
repository link (if public, optional): -
code snippet to reproduce:

fn main() {
    let n = 3;
    let b = n();
   // show `expected function, found i32rust-analyzer[E0618](https://doc.rust-lang.org/stable/error_codes/E0618.html)`
   // only when "rust-analyzer.diagnostics.experimental.enable": true
}

I'd like to test out the diagnostics https://rust-analyzer.github.io/manual.html#expected-function but it seems it is actually "experimental" and is only enabled when "rust-analyzer.diagnostics.experimental.enable": true is set to true in .vscode/settings.json.
I think the documentation is supposed to make it clear with the configuration of experimental diagnostics in the auto-generated documentation. If possible I think I can make a PR to help.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the rust-analyzer manual's expected-function section and the documentation for rust-analyzer.diagnostics.experimental.enable. Update the auto-generated documentation so experimental diagnostics are identified clearly, then verify that the setting and diagnostic behavior are described consistently.

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
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.