Rollup merge of #102351 - Rageking8:improve-E0585, r=wesleywiser

JohnTitor · web-flow · commit 19e84b91e564 · 2022-09-29T11:42:04.000+09:00
Improve E0585 help
diff --git a/compiler/rustc_error_messages/locales/en-US/parser.ftl b/compiler/rustc_error_messages/locales/en-US/parser.ftl
@@ -245,7 +245,7 @@ parser_assignment_else_not_allowed = <assignment> ... else {"{"} ... {"}"} is no
 parser_expected_statement_after_outer_attr = expected statement after outer attribute
 
 parser_doc_comment_does_not_document_anything = found a documentation comment that doesn't document anything
-    .help = doc comments must come before what they document, maybe a comment was intended with `//`?
+    .help = doc comments must come before what they document, if a comment was intended use `//`
     .suggestion = missing comma here
 
 parser_const_let_mutually_exclusive = `const` and `let` are mutually exclusive
diff --git a/compiler/rustc_parse/src/parser/item.rs b/compiler/rustc_parse/src/parser/item.rs
@@ -760,8 +760,8 @@ impl<'a> Parser<'a> {
                 )
                 .span_label(self.token.span, "this doc comment doesn't document anything")
                 .help(
-                    "doc comments must come before what they document, maybe a \
-                    comment was intended with `//`?",
+                    "doc comments must come before what they document, if a comment was \
+                    intended use `//`",
                 )
                 .emit();
                 self.bump();
diff --git a/src/test/ui/error-codes/E0585.stderr b/src/test/ui/error-codes/E0585.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     /// Hello! I'm useless...
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-after-struct-field.rs b/src/test/ui/parser/doc-after-struct-field.rs
@@ -1,13 +1,13 @@
 struct X {
     a: u8 /** document a */,
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
 
 struct Y {
     a: u8 /// document a
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
 
 fn main() {
diff --git a/src/test/ui/parser/doc-after-struct-field.stderr b/src/test/ui/parser/doc-after-struct-field.stderr
@@ -4,15 +4,15 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     a: u8 /** document a */,
    |           ^^^^^^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error[E0585]: found a documentation comment that doesn't document anything
   --> $DIR/doc-after-struct-field.rs:8:11
    |
 LL |     a: u8 /// document a
    |           ^^^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to 2 previous errors
 
diff --git a/src/test/ui/parser/doc-before-extern-rbrace.stderr b/src/test/ui/parser/doc-before-extern-rbrace.stderr
@@ -4,7 +4,7 @@ error[E0584]: found a documentation comment that doesn't document anything
 LL |     /// hi
    |     ^^^^^^ this doc comment doesn't document anything
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-before-fn-rbrace.rs b/src/test/ui/parser/doc-before-fn-rbrace.rs
@@ -1,5 +1,5 @@
 fn main() {
     /// document
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
diff --git a/src/test/ui/parser/doc-before-fn-rbrace.stderr b/src/test/ui/parser/doc-before-fn-rbrace.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     /// document
    |     ^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-before-rbrace.rs b/src/test/ui/parser/doc-before-rbrace.rs
@@ -1,5 +1,5 @@
 fn main() {
     println!("Hi"); /// hi
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
diff --git a/src/test/ui/parser/doc-before-rbrace.stderr b/src/test/ui/parser/doc-before-rbrace.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     println!("Hi"); /// hi
    |                     ^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-before-semi.rs b/src/test/ui/parser/doc-before-semi.rs
@@ -1,6 +1,6 @@
 fn main() {
     /// hi
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
     ;
 }
diff --git a/src/test/ui/parser/doc-before-semi.stderr b/src/test/ui/parser/doc-before-semi.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     /// hi
    |     ^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-before-struct-rbrace-1.rs b/src/test/ui/parser/doc-before-struct-rbrace-1.rs
@@ -2,7 +2,7 @@ struct X {
     a: u8,
     /// document
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
 
 fn main() {
diff --git a/src/test/ui/parser/doc-before-struct-rbrace-1.stderr b/src/test/ui/parser/doc-before-struct-rbrace-1.stderr
@@ -7,7 +7,7 @@ LL |     a: u8,
 LL |     /// document
    |     ^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-before-struct-rbrace-2.rs b/src/test/ui/parser/doc-before-struct-rbrace-2.rs
@@ -1,7 +1,7 @@
 struct X {
     a: u8 /// document
     //~^ ERROR found a documentation comment that doesn't document anything
-    //~| HELP maybe a comment was intended
+    //~| HELP if a comment was intended use `//`
 }
 
 fn main() {
diff --git a/src/test/ui/parser/doc-before-struct-rbrace-2.stderr b/src/test/ui/parser/doc-before-struct-rbrace-2.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     a: u8 /// document
    |           ^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/doc-inside-trait-item.stderr b/src/test/ui/parser/doc-inside-trait-item.stderr
@@ -4,7 +4,7 @@ error[E0584]: found a documentation comment that doesn't document anything
 LL |     /// empty doc
    |     ^^^^^^^^^^^^^ this doc comment doesn't document anything
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/issues/issue-34222-1.stderr b/src/test/ui/parser/issues/issue-34222-1.stderr
@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything
 LL |     /// comment
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 
diff --git a/src/test/ui/parser/issues/issue-48636.stderr b/src/test/ui/parser/issues/issue-48636.stderr
@@ -8,7 +8,7 @@ LL |     x: u8
 LL |     /// The ID of the parent core
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-   = help: doc comments must come before what they document, maybe a comment was intended with `//`?
+   = help: doc comments must come before what they document, if a comment was intended use `//`
 
 error: aborting due to previous error
 

Original file line number	Diff line number	Diff line change
`@@ -760,8 +760,8 @@ impl<'a> Parser<'a> {`
`760`	`760`	`)`
`761`	`761`	`.span_label(self.token.span, "this doc comment doesn't document anything")`
`762`	`762`	`.help(`
`763`		`- "doc comments must come before what they document, maybe a \`
`764`		- comment was intended with `//`?",
	`763`	`+ "doc comments must come before what they document, if a comment was \`
	`764`	+ intended use `//`",
`765`	`765`	`)`
`766`	`766`	`.emit();`
`767`	`767`	`self.bump();`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything`
`4`	`4`	`LL \| /// Hello! I'm useless...`
`5`	`5`	`\| ^^^^^^^^^^^^^^^^^^^^^^^^^`
`6`	`6`	`\|`
`7`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`7`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`8`	`8`
`9`	`9`	`error: aborting due to previous error`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,13 @@`
`1`	`1`	`struct X {`
`2`	`2`	`a: u8 /** document a */,`
`3`	`3`	`//~^ ERROR found a documentation comment that doesn't document anything`
`4`		`- //~\| HELP maybe a comment was intended`
	`4`	+ //~\| HELP if a comment was intended use `//`
`5`	`5`	`}`
`6`	`6`
`7`	`7`	`struct Y {`
`8`	`8`	`a: u8 /// document a`
`9`	`9`	`//~^ ERROR found a documentation comment that doesn't document anything`
`10`		`- //~\| HELP maybe a comment was intended`
	`10`	+ //~\| HELP if a comment was intended use `//`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`fn main() {`
Original file line number	Diff line number	Diff line change
`@@ -4,15 +4,15 @@ error[E0585]: found a documentation comment that doesn't document anything`
`4`	`4`	`LL \| a: u8 /** document a */,`
`5`	`5`	`\| ^^^^^^^^^^^^^^^^^`
`6`	`6`	`\|`
`7`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`7`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`8`	`8`
`9`	`9`	`error[E0585]: found a documentation comment that doesn't document anything`
`10`	`10`	`--> $DIR/doc-after-struct-field.rs:8:11`
`11`	`11`	`\|`
`12`	`12`	`LL \| a: u8 /// document a`
`13`	`13`	`\| ^^^^^^^^^^^^^^`
`14`	`14`	`\|`
`15`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`15`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`16`	`16`
`17`	`17`	`error: aborting due to 2 previous errors`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ error[E0584]: found a documentation comment that doesn't document anything`
`4`	`4`	`LL \| /// hi`
`5`	`5`	`\| ^^^^^^ this doc comment doesn't document anything`
`6`	`6`	`\|`
`7`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`7`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`8`	`8`
`9`	`9`	`error: aborting due to previous error`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`fn main() {`
`2`	`2`	`/// document`
`3`	`3`	`//~^ ERROR found a documentation comment that doesn't document anything`
`4`		`- //~\| HELP maybe a comment was intended`
	`4`	+ //~\| HELP if a comment was intended use `//`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything`
`4`	`4`	`LL \| /// document`
`5`	`5`	`\| ^^^^^^^^^^^^`
`6`	`6`	`\|`
`7`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`7`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`8`	`8`
`9`	`9`	`error: aborting due to previous error`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`fn main() {`
`2`	`2`	`println!("Hi"); /// hi`
`3`	`3`	`//~^ ERROR found a documentation comment that doesn't document anything`
`4`		`- //~\| HELP maybe a comment was intended`
	`4`	+ //~\| HELP if a comment was intended use `//`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ error[E0585]: found a documentation comment that doesn't document anything`
`4`	`4`	`LL \| println!("Hi"); /// hi`
`5`	`5`	`\| ^^^^^^`
`6`	`6`	`\|`
`7`		- = help: doc comments must come before what they document, maybe a comment was intended with `//`?
	`7`	+ = help: doc comments must come before what they document, if a comment was intended use `//`
`8`	`8`
`9`	`9`	`error: aborting due to previous error`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`fn main() {`
`2`	`2`	`/// hi`
`3`	`3`	`//~^ ERROR found a documentation comment that doesn't document anything`
`4`		`- //~\| HELP maybe a comment was intended`
	`4`	+ //~\| HELP if a comment was intended use `//`
`5`	`5`	`;`
`6`	`6`	`}`