Fill out documentation for new lint

rust-lang · Mar 8, 2022 · 1593ce8 · 1593ce8
1 parent 2677eca
commit 1593ce8
Showing 1 changed file with 15 additions and 2 deletions.
diff --git 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",