doc_comment_double_space_linebreak: Use multi spans and suggestions

Author: xFrednet

clippy_lints/src/doc/doc_comment_double_space_linebreak.rs

@@ -1,20 +1,33 @@
-use clippy_utils::diagnostics::span_lint_and_sugg;
+use clippy_utils::diagnostics::span_lint_and_then;
 use rustc_errors::Applicability;
 use rustc_lint::LateContext;
 use rustc_span::{BytePos, Span};
 
 use super::DOC_COMMENT_DOUBLE_SPACE_LINEBREAK;
 
 pub fn check(cx: &LateContext<'_>, collected_breaks: &[Span]) {
-    for r_span in collected_breaks {
-        span_lint_and_sugg(
-            cx,
-            DOC_COMMENT_DOUBLE_SPACE_LINEBREAK,
-            r_span.with_hi(r_span.lo() + BytePos(2)),
-            "doc comment uses two spaces for a hard line break",
-            "replace this double space with a backslash",
-            "\\".to_owned(),
-            Applicability::MachineApplicable,
-        );
+    if collected_breaks.is_empty() {
+        return;
     }
+
+    let breaks: Vec<_> = collected_breaks
+        .iter()
+        .map(|span| span.with_hi(span.lo() + BytePos(2)))
+        .collect();
+
+    span_lint_and_then(
+        cx,
+        DOC_COMMENT_DOUBLE_SPACE_LINEBREAK,
+        breaks.clone(),
+        "doc comment uses two spaces for a hard line break",
+        |diag| {
+            let suggs: Vec<_> = breaks.iter().map(|span| (*span, "\\".to_string())).collect();
+            diag.tool_only_multipart_suggestion(
+                "replace this double space with a backslash:",
+                suggs,
+                Applicability::MachineApplicable,
+            );
+            diag.help("replace this double space with a backslash: `\\`");
+        },
+    );
 }

tests/ui/doc/doc_comment_double_space_linebreak.stderr

@@ -2,64 +2,49 @@ error: doc comment uses two spaces for a hard line break
   --> tests/ui/doc/doc_comment_double_space_linebreak.rs:7:43
    |
 LL | //! Should warn on double space linebreaks  
-   |                                           ^^ help: replace this double space with a backslash: `\`
+   |                                           ^^
    |
+   = help: replace this double space with a backslash: `\`
    = note: `-D clippy::doc-comment-double-space-linebreak` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::doc_comment_double_space_linebreak)]`
 
 error: doc comment uses two spaces for a hard line break
   --> tests/ui/doc/doc_comment_double_space_linebreak.rs:35:51
    |
 LL | /// Should warn when doc comment uses double space  
-   |                                                   ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:36:50
-   |
+   |                                                   ^^
 LL | /// as a line-break, even when there are multiple  
-   |                                                  ^^ help: replace this double space with a backslash: `\`
+   |                                                  ^^
+   |
+   = help: replace this double space with a backslash: `\`
 
 error: doc comment uses two spaces for a hard line break
   --> tests/ui/doc/doc_comment_double_space_linebreak.rs:44:12
    |
 LL | /// 🌹 are 🟥  
-   |              ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:45:12
-   |
+   |              ^^
 LL | /// 🌷 are 🟦  
-   |              ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:46:11
-   |
+   |              ^^
 LL | /// 📎 is 😎  
-   |             ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:47:17
-   |
+   |             ^^
 LL | /// and so are 🫵  
-   |                  ^^ help: replace this double space with a backslash: `\`
+   |                  ^^
+   |
+   = help: replace this double space with a backslash: `\`
 
 error: doc comment uses two spaces for a hard line break
   --> tests/ui/doc/doc_comment_double_space_linebreak.rs:86:16
    |
 LL | /// here we mix  
-   |                ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:88:13
-   |
+   |                ^^
+LL | /// double spaces\
 LL | /// and also  
-   |             ^^ help: replace this double space with a backslash: `\`
-
-error: doc comment uses two spaces for a hard line break
-  --> tests/ui/doc/doc_comment_double_space_linebreak.rs:90:20
-   |
+   |             ^^
+LL | /// adding backslash\
 LL | /// to some of them  
-   |                    ^^ help: replace this double space with a backslash: `\`
+   |                    ^^
+   |
+   = help: replace this double space with a backslash: `\`
 
-error: aborting due to 10 previous errors
+error: aborting due to 4 previous errors