about summary refs log tree commit diff
path: root/clippy_dev/src
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2020-03-18 01:43:39 +0100
committerMatthias Krüger <matthias.krueger@famsik.de>2020-03-18 01:43:39 +0100
commit7545925ffef174a4951f564ca0c80bbb300ed6a0 (patch)
tree14bf78c001af669cbfc86ac3f63872ac440195d0 /clippy_dev/src
parent23549a8c362a403026432f65a6cb398cb10d44b7 (diff)
downloadrust-7545925ffef174a4951f564ca0c80bbb300ed6a0.tar.gz
rust-7545925ffef174a4951f564ca0c80bbb300ed6a0.zip
new_lint.rs: encourage authors to write more detailed code samples in lint descriptions (linted as well as fixed code)
changelog: none
Diffstat (limited to 'clippy_dev/src')
-rw-r--r--clippy_dev/src/new_lint.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/clippy_dev/src/new_lint.rs b/clippy_dev/src/new_lint.rs
index a3ccb2758e2..9e2a4617cde 100644
--- a/clippy_dev/src/new_lint.rs
+++ b/clippy_dev/src/new_lint.rs
@@ -131,7 +131,11 @@ declare_clippy_lint! {{
     /// **Example:**
     ///
     /// ```rust
-    /// // example code
+    /// // example code where clippy issues a warning
+    /// ```
+    /// Use instead:
+    /// ```rust
+    /// // example code which does not raise clippy warning
     /// ```
     pub {name_upper},
     {category},