Account for /// when rendering multiline spans

estebank · estebank · commit f33deb751108 · 2024-12-13T18:48:33.000Z
Don't consider `///` and `//!` docstrings to be empty for the purposes of multiline span rendering.
diff --git a/tests/ui/doc/unbalanced_ticks.stderr b/tests/ui/doc/unbalanced_ticks.stderr
@@ -3,7 +3,9 @@ error: backticks are unbalanced
    |
 LL |   /// This is a doc comment with `unbalanced_tick marks and several words that
    |  _____^
-...  |
+LL | |
+LL | | /// should be `encompassed_by` tick marks because they `contain_underscores`.
+LL | | /// Because of the initial `unbalanced_tick` pair, the error message is
 LL | | /// very `confusing_and_misleading`.
    | |____________________________________^
    |
diff --git a/tests/ui/empty_line_after/doc_comments.stderr b/tests/ui/empty_line_after/doc_comments.stderr
@@ -96,6 +96,9 @@ error: empty lines after doc comment
   --> tests/ui/empty_line_after/doc_comments.rs:63:5
    |
 LL | /     /// for OldA
+LL | |     // struct OldA;
+LL | |
+LL | |     /// Docs
 ...  |
 LL | |
    | |_^
diff --git a/tests/ui/needless_doc_main.stderr b/tests/ui/needless_doc_main.stderr
@@ -3,7 +3,9 @@ error: needless `fn main` in doctest
    |
 LL |   /// fn main() {
    |  _____^
-...  |
+LL | |
+LL | |
+LL | | ///     unimplemented!();
 LL | | /// }
    | |_____^
    |
@@ -15,7 +17,8 @@ error: needless `fn main` in doctest
    |
 LL |   /// fn main() -> () {
    |  _____^
-...  |
+LL | |
+LL | | ///     unimplemented!();
 LL | | /// }
    | |_____^
 
@@ -24,7 +27,8 @@ error: needless `fn main` in doctest
    |
 LL |   /// fn main() {
    |  _____^
-...  |
+LL | |
+LL | | ///     unimplemented!();
 LL | | /// }
    | |_____^
 
@@ -33,7 +37,9 @@ error: needless `fn main` in doctest
    |
 LL |   /// // the fn is not always the first line
    |  _____^
-...  |
+LL | |
+LL | | /// fn main() {
+LL | | ///     unimplemented!();
 LL | | /// }
    | |_____^
 
diff --git a/tests/ui/suspicious_doc_comments_unfixable.stderr b/tests/ui/suspicious_doc_comments_unfixable.stderr
@@ -2,7 +2,10 @@ error: this is an outer doc comment and does not apply to the parent module or c
   --> tests/ui/suspicious_doc_comments_unfixable.rs:4:1
    |
 LL | / ///! a
-...  |
+LL | |
+LL | |
+LL | | ///! b
+LL | | /// c
 LL | | ///! d
    | |______^
    |
@@ -22,7 +25,9 @@ error: this is an outer doc comment and does not apply to the parent module or c
   --> tests/ui/suspicious_doc_comments_unfixable.rs:12:1
    |
 LL | / ///! a
-...  |
+LL | |
+LL | | ///! b
+LL | | /// c
 LL | | ///! d
    | |______^
    |
diff --git a/tests/ui/too_long_first_doc_paragraph-fix.stderr b/tests/ui/too_long_first_doc_paragraph-fix.stderr
@@ -2,7 +2,9 @@ error: first doc comment paragraph is too long
   --> tests/ui/too_long_first_doc_paragraph-fix.rs:3:1
    |
 LL | / /// A very short summary.
-...  |
+LL | | /// A much longer explanation that goes into a lot more detail about
+LL | | /// how the thing works, possibly with doclinks and so one,
+LL | | /// and probably spanning a many rows. Blablabla, it needs to be over
 LL | | /// 200 characters so I needed to write something longeeeeeeer.
    | |_^
    |
diff --git a/tests/ui/too_long_first_doc_paragraph.stderr b/tests/ui/too_long_first_doc_paragraph.stderr
@@ -2,7 +2,9 @@ error: first doc comment paragraph is too long
   --> tests/ui/too_long_first_doc_paragraph.rs:8:5
    |
 LL | /     //! A very short summary.
-...  |
+LL | |     //! A much longer explanation that goes into a lot more detail about
+LL | |     //! how the thing works, possibly with doclinks and so one,
+LL | |     //! and probably spanning a many rows. Blablabla, it needs to be over
 LL | |     //! 200 characters so I needed to write something longeeeeeeer.
    | |____^
    |
@@ -27,7 +29,8 @@ error: first doc comment paragraph is too long
   --> tests/ui/too_long_first_doc_paragraph.rs:36:1
    |
 LL | / /// Lorem
-...  |
+LL | | /// ipsum dolor sit amet, consectetur adipiscing elit. Nunc turpis nunc, lacinia
+LL | | /// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,
 LL | | /// gravida non lacinia at, rhoncus eu lacus.
    | |_^
 

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,9 @@ error: backticks are unbalanced`
`3`	`3`	`\|`
`4`	`4`	LL \| /// This is a doc comment with `unbalanced_tick marks and several words that
`5`	`5`	`\| _____^`
`6`		`-... \|`
	`6`	`+LL \| \|`
	`7`	+LL \| \| /// should be `encompassed_by` tick marks because they `contain_underscores`.
	`8`	+LL \| \| /// Because of the initial `unbalanced_tick` pair, the error message is
`7`	`9`	LL \| \| /// very `confusing_and_misleading`.
`8`	`10`	`\| \|____________________________________^`
`9`	`11`	`\|`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,10 @@ error: this is an outer doc comment and does not apply to the parent module or c`
`2`	`2`	`--> tests/ui/suspicious_doc_comments_unfixable.rs:4:1`
`3`	`3`	`\|`
`4`	`4`	`LL \| / ///! a`
`5`		`-... \|`
	`5`	`+LL \| \|`
	`6`	`+LL \| \|`
	`7`	`+LL \| \| ///! b`
	`8`	`+LL \| \| /// c`
`6`	`9`	`LL \| \| ///! d`
`7`	`10`	`\| \|______^`
`8`	`11`	`\|`
`@@ -22,7 +25,9 @@ error: this is an outer doc comment and does not apply to the parent module or c`
`22`	`25`	`--> tests/ui/suspicious_doc_comments_unfixable.rs:12:1`
`23`	`26`	`\|`
`24`	`27`	`LL \| / ///! a`
`25`		`-... \|`
	`28`	`+LL \| \|`
	`29`	`+LL \| \| ///! b`
	`30`	`+LL \| \| /// c`
`26`	`31`	`LL \| \| ///! d`
`27`	`32`	`\| \|______^`
`28`	`33`	`\|`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@ error: first doc comment paragraph is too long`
`2`	`2`	`--> tests/ui/too_long_first_doc_paragraph-fix.rs:3:1`
`3`	`3`	`\|`
`4`	`4`	`LL \| / /// A very short summary.`
`5`		`-... \|`
	`5`	`+LL \| \| /// A much longer explanation that goes into a lot more detail about`
	`6`	`+LL \| \| /// how the thing works, possibly with doclinks and so one,`
	`7`	`+LL \| \| /// and probably spanning a many rows. Blablabla, it needs to be over`
`6`	`8`	`LL \| \| /// 200 characters so I needed to write something longeeeeeeer.`
`7`	`9`	`\| \|_^`
`8`	`10`	`\|`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@ error: first doc comment paragraph is too long`
`2`	`2`	`--> tests/ui/too_long_first_doc_paragraph.rs:8:5`
`3`	`3`	`\|`
`4`	`4`	`LL \| / //! A very short summary.`
`5`		`-... \|`
	`5`	`+LL \| \| //! A much longer explanation that goes into a lot more detail about`
	`6`	`+LL \| \| //! how the thing works, possibly with doclinks and so one,`
	`7`	`+LL \| \| //! and probably spanning a many rows. Blablabla, it needs to be over`
`6`	`8`	`LL \| \| //! 200 characters so I needed to write something longeeeeeeer.`
`7`	`9`	`\| \|____^`
`8`	`10`	`\|`
`@@ -27,7 +29,8 @@ error: first doc comment paragraph is too long`
`27`	`29`	`--> tests/ui/too_long_first_doc_paragraph.rs:36:1`
`28`	`30`	`\|`
`29`	`31`	`LL \| / /// Lorem`
`30`		`-... \|`
	`32`	`+LL \| \| /// ipsum dolor sit amet, consectetur adipiscing elit. Nunc turpis nunc, lacinia`
	`33`	`+LL \| \| /// a dolor in, pellentesque aliquet enim. Cras nec maximus sem. Mauris arcu libero,`
`31`	`34`	`LL \| \| /// gravida non lacinia at, rhoncus eu lacus.`
`32`	`35`	`\| \|_^`
`33`	`36`