about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorBenjamin Coenen <5719034+bnjjj@users.noreply.github.com>2020-10-20 21:29:31 +0200
committerBenjamin Coenen <5719034+bnjjj@users.noreply.github.com>2020-10-20 21:29:31 +0200
commitaa031e91f4f809933eb967edda256ebf6b8bf4ea (patch)
treec78e34fbda9795c0671c71661a6c63faaf596a3b /docs
parentc00339509d27061f77dac5eef33335095afea8ec (diff)
downloadrust-aa031e91f4f809933eb967edda256ebf6b8bf4ea.tar.gz
rust-aa031e91f4f809933eb967edda256ebf6b8bf4ea.zip
add completions for clippy lint in attributes
Signed-off-by: Benjamin Coenen <5719034+bnjjj@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/user/generated_diagnostic.adoc105
1 files changed, 105 insertions, 0 deletions
diff --git a/docs/user/generated_diagnostic.adoc b/docs/user/generated_diagnostic.adoc
new file mode 100644
index 00000000000..ec45d0c2b8f
--- /dev/null
+++ b/docs/user/generated_diagnostic.adoc
@@ -0,0 +1,105 @@
+//Generated file, do not edit by hand, see `xtask/src/codegen`
+=== break-outside-of-loop
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L219[diagnostics.rs]
+
+This diagnostic is triggered if `break` keyword is used outside of a loop.
+
+
+=== incorrect-ident-case
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L319[diagnostics.rs]
+
+This 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].
+
+
+=== mismatched-arg-count
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L267[diagnostics.rs]
+
+This diagnostic is triggered if function is invoked with an incorrect amount of arguments.
+
+
+=== missing-match-arm
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L162[diagnostics.rs]
+
+This diagnostic is triggered if `match` block is missing one or more match arms.
+
+
+=== missing-ok-in-tail-expr
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L187[diagnostics.rs]
+
+This diagnostic is triggered if block that should return `Result` returns a value not wrapped in `Ok`.
+
+Example:
+
+```rust
+fn foo() -> Result<u8, ()> {
+    10
+}
+```
+
+
+=== missing-pat-fields
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L113[diagnostics.rs]
+
+This diagnostic is triggered if pattern lacks some fields that exist in the corresponding structure.
+
+Example:
+
+```rust
+struct A { a: u8, b: u8 }
+
+let a = A { a: 10, b: 20 };
+
+if let A { a } = a {
+    // ...
+}
+```
+
+
+=== missing-structure-fields
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L66[diagnostics.rs]
+
+This diagnostic is triggered if record lacks some fields that exist in the corresponding structure.
+
+Example:
+
+```rust
+struct A { a: u8, b: u8 }
+
+let a = A { a: 10 };
+```
+
+
+=== missing-unsafe
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L243[diagnostics.rs]
+
+This diagnostic is triggered if operation marked as `unsafe` is used outside of `unsafe` function or block.
+
+
+=== no-such-field
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_ty/src/diagnostics.rs#L39[diagnostics.rs]
+
+This diagnostic is triggered if created structure does not have field provided in record.
+
+
+=== unconfigured-code
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L90[diagnostics.rs]
+
+This diagnostic is shown for code with inactive `#[cfg]` attributes.
+
+
+=== unresolved-extern-crate
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L35[diagnostics.rs]
+
+This diagnostic is triggered if rust-analyzer is unable to discover referred extern crate.
+
+
+=== unresolved-import
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L59[diagnostics.rs]
+
+This diagnostic is triggered if rust-analyzer is unable to discover imported module.
+
+
+=== unresolved-module
+**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/hir_def/src/diagnostics.rs#L10[diagnostics.rs]
+
+This diagnostic is triggered if rust-analyzer is unable to discover referred module.