diff options
| author | David Koloski <dkoloski@google.com> | 2022-02-28 22:28:45 +0000 |
|---|---|---|
| committer | David Koloski <dkoloski@google.com> | 2022-03-08 19:09:30 +0000 |
| commit | 1593ce8609714f4717a9db964507bf4fdf1e400d (patch) | |
| tree | 7a77866611421fa22dbf692bf0b3a1f83e3e365c | |
| parent | 2677eca237c92877ac8b0aca4cc58f8a14061ab3 (diff) | |
| download | rust-1593ce8609714f4717a9db964507bf4fdf1e400d.tar.gz rust-1593ce8609714f4717a9db964507bf4fdf1e400d.zip | |
Fill out documentation for new lint
| -rw-r--r-- | compiler/rustc_lint_defs/src/builtin.rs | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/compiler/rustc_lint_defs/src/builtin.rs b/compiler/rustc_lint_defs/src/builtin.rs index f6ad46cc018..7f1591a7212 100644 --- a/compiler/rustc_lint_defs/src/builtin.rs +++ b/compiler/rustc_lint_defs/src/builtin.rs @@ -3774,8 +3774,21 @@ declare_lint! { } declare_lint! { - #[doc(hidden)] - /// Added for testing unsable lints; perma-unstable. + /// The `test_unstable_lint` lint tests unstable lints and is perma-unstable. + /// + /// ### Example + /// + /// ``` + /// #![allow(test_unstable_lint)] + /// ``` + /// + /// {{produces}} + /// + /// ### Explanation + /// + /// In order to test the behavior of unstable traits, a permanently-unstable + /// lint is required. This lint can be used to trigger warnings and errors + /// from the compiler related to unstable lints. pub TEST_UNSTABLE_LINT, Deny, "this unstable lint is only for testing", |