Fix the root of the problem

Author: blyxyas

clippy_lints/src/doc.rs

@@ -454,6 +454,18 @@ fn lint_for_missing_headers(
 #[expect(clippy::cast_possible_truncation)]
 #[must_use]
 pub fn strip_doc_comment_decoration(doc: &str, comment_kind: CommentKind, span: Span) -> (String, Vec<(usize, Span)>) {
+    fn get_line_indentation(line: &Vec<char>) -> u32 {
+        let mut indent = 0;
+        for c in line {
+            if *c == ' ' {
+                indent += 1;
+            } else if *c == '\n' {
+                indent += 4;
+            }; // Standard "Tab" space
+        }
+        indent
+    }
+
     // one-line comments lose their prefix
     if comment_kind == CommentKind::Line {
         let mut doc = doc.to_owned();
@@ -465,15 +477,32 @@ pub fn strip_doc_comment_decoration(doc: &str, comment_kind: CommentKind, span:
 
     let mut sizes = vec![];
     let mut contains_initial_stars = false;
+    let mut least_indented = 10; // (Hoping the document has less indentation than 10)
     for line in doc.lines() {
         let offset = line.as_ptr() as usize - doc.as_ptr() as usize;
         debug_assert_eq!(offset as u32 as usize, offset);
+        if !line.is_empty() {
+            // Empty lines don't have indentation
+            let line_indent = get_line_indentation(&line.chars().collect::<Vec<char>>());
+            if line_indent < least_indented {
+                least_indented = line_indent;
+            };
+        };
         contains_initial_stars |= line.trim_start().starts_with('*');
         // +1 adds the newline, +3 skips the opening delimiter
         sizes.push((line.len() + 1, span.with_lo(span.lo() + BytePos(3 + offset as u32))));
     }
     if !contains_initial_stars {
-        return (doc.to_string(), sizes);
+        let mut new_doc = Vec::new();
+        for line in doc.lines() {
+            if line.len() >= least_indented as usize {
+                new_doc.push(&line[least_indented.saturating_sub(1) as usize..]); // Sometimes users start the comment the same line the doc comment is defined.
+                // /** Example of this behaviour
+                // (Some description)
+                // */
+            };
+        }
+        return (new_doc.join("\n"), sizes);
     }
     // remove the initial '*'s if any
     let mut no_stars = String::with_capacity(doc.len());
@@ -646,9 +675,7 @@ fn check_doc<'a, Events: Iterator<Item = (pulldown_cmark::Event<'a>, Range<usize
                 headers.safety |= in_heading && trimmed_text == "Implementation safety";
                 headers.safety |= in_heading && trimmed_text == "Implementation Safety";
                 headers.errors |= in_heading && trimmed_text == "Errors";
-                headers.errors |= trimmed_text.contains("# Errors\n"); // For /** Doc comments */
                 headers.panics |= in_heading && trimmed_text == "Panics";
-                headers.panics |= trimmed_text.contains("# Panics\n");
                 if in_code {
                     if is_rust {
                         let edition = edition.unwrap_or_else(|| cx.tcx.sess.edition());

tests/ui/doc_errors.rs

@@ -64,6 +64,10 @@ impl Struct1 {
     }
 
     /**
+    Before text
+    ```
+        Indentation block
+    ```
     # Errors
     Hi
      */
@@ -73,7 +77,7 @@ impl Struct1 {
 
     /**
     This is not sufficiently documented.
-     */
+    */
     pub fn pub_method_missing_block_errors_header() -> Result<(), ()> {
         unimplemented!();
     }

tests/ui/doc_errors.stderr

@@ -37,13 +37,13 @@ LL |     pub async fn async_pub_method_missing_errors_header() -> Result<(), ()>
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error: docs for function returning `Result` missing `# Errors` section
-  --> $DIR/doc_errors.rs:77:5
+  --> $DIR/doc_errors.rs:81:5
    |
 LL |     pub fn pub_method_missing_block_errors_header() -> Result<(), ()> {
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error: docs for function returning `Result` missing `# Errors` section
-  --> $DIR/doc_errors.rs:100:5
+  --> $DIR/doc_errors.rs:104:5
    |
 LL |     fn trait_method_missing_errors_header() -> Result<(), ()>;
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^