aboutsummaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/generated_diagnostic.adoc119
1 files changed, 0 insertions, 119 deletions
diff --git a/docs/user/generated_diagnostic.adoc b/docs/user/generated_diagnostic.adoc
deleted file mode 100644
index ec8581a03..000000000
--- a/docs/user/generated_diagnostic.adoc
+++ /dev/null
@@ -1,119 +0,0 @@
1//Generated file, do not edit by hand, see `xtask/src/codegen`
2=== break-outside-of-loop
3**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L219[diagnostics.rs]
4
5This diagnostic is triggered if `break` keyword is used outside of a loop.
6
7
8=== inactive-code
9**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L98[diagnostics.rs]
10
11This diagnostic is shown for code with inactive `#[cfg]` attributes.
12
13
14=== incorrect-ident-case
15**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L319[diagnostics.rs]
16
17This diagnostic is triggered if item name doesn't follow https://doc.rust-lang.org/1.0.0/style/style/naming/README.html[Rust naming convention].
18
19
20=== macro-error
21**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L167[diagnostics.rs]
22
23This diagnostic is shown for macro expansion errors.
24
25
26=== mismatched-arg-count
27**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L267[diagnostics.rs]
28
29This diagnostic is triggered if function is invoked with an incorrect amount of arguments.
30
31
32=== missing-match-arm
33**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L162[diagnostics.rs]
34
35This diagnostic is triggered if `match` block is missing one or more match arms.
36
37
38=== missing-ok-in-tail-expr
39**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L187[diagnostics.rs]
40
41This diagnostic is triggered if block that should return `Result` returns a value not wrapped in `Ok`.
42
43Example:
44
45```rust
46fn foo() -> Result<u8, ()> {
47 10
48}
49```
50
51
52=== missing-pat-fields
53**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L113[diagnostics.rs]
54
55This diagnostic is triggered if pattern lacks some fields that exist in the corresponding structure.
56
57Example:
58
59```rust
60struct A { a: u8, b: u8 }
61
62let a = A { a: 10, b: 20 };
63
64if let A { a } = a {
65 // ...
66}
67```
68
69
70=== missing-structure-fields
71**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L66[diagnostics.rs]
72
73This diagnostic is triggered if record lacks some fields that exist in the corresponding structure.
74
75Example:
76
77```rust
78struct A { a: u8, b: u8 }
79
80let a = A { a: 10 };
81```
82
83
84=== missing-unsafe
85**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L243[diagnostics.rs]
86
87This diagnostic is triggered if operation marked as `unsafe` is used outside of `unsafe` function or block.
88
89
90=== no-such-field
91**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L39[diagnostics.rs]
92
93This diagnostic is triggered if created structure does not have field provided in record.
94
95
96=== unresolved-extern-crate
97**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L43[diagnostics.rs]
98
99This diagnostic is triggered if rust-analyzer is unable to discover referred extern crate.
100
101
102=== unresolved-import
103**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L67[diagnostics.rs]
104
105This diagnostic is triggered if rust-analyzer is unable to discover imported module.
106
107
108=== unresolved-module
109**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L18[diagnostics.rs]
110
111This diagnostic is triggered if rust-analyzer is unable to discover referred module.
112
113
114=== unresolved-proc-macro
115**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L131[diagnostics.rs]
116
117This diagnostic is shown when a procedural macro can not be found. This usually means that
118procedural macro support is simply disabled (and hence is only a weak hint instead of an error),
119but can also indicate project setup problems.