Simplify language around DOC_SUSPICIOUS_FOOTNOTES

Author: notriddle

clippy_lints/src/doc/mod.rs

@@ -611,18 +611,12 @@ declare_clippy_lint! {
 
 declare_clippy_lint! {
     /// ### What it does
-    /// Detects syntax that looks like a footnote reference,
-    /// because it matches the regexp `\[\^[0-9]+\]`,
-    /// but has no referent.
+    /// Detects syntax that looks like a footnote reference.
     ///
     /// Rustdoc footnotes are compatible with GitHub-Flavored Markdown (GFM).
-    /// They are not parsed as footnotes unless a definition also exists,
-    /// so they usually "do what you mean" if you want to write the text
-    /// literally—usually in a regular expression.
-    ///
-    /// However, footnote references are usually numbers, and regex
-    /// negative character classes usually contain other characters, so this
-    /// lint can make a practical guess for which is meant.
+    /// GFM does not parse a footnote reference unless its definition also
+    /// exists. This lint checks for footnote references with missing
+    /// definitions, unless it thinks you're writing a regex.
     ///
     /// ### Why is this bad?
     /// This probably means that a footnote was meant to exist,