Clarify unused_doc_comments note on macro invocations

dtolnay · dtolnay · commit 3a8097f2b44f · 2020-04-21T21:16:50.000-07:00
diff --git a/src/librustc_lint/context.rs b/src/librustc_lint/context.rs
@@ -566,7 +566,7 @@ pub trait LintContext: Sized {
                     stability::deprecation_suggestion(&mut db, suggestion, span)
                 }
                 BuiltinLintDiagnostics::UnusedDocComment(span) => {
-                    db.span_label(span, "rustdoc does not generate documentation for macros");
+                    db.span_label(span, "rustdoc does not generate documentation for macro invocations");
                     db.help("to document an item produced by a macro, \
                                   the macro must produce the documentation as part of its expansion");
                 }
diff --git a/src/test/ui/useless-comment.stderr b/src/test/ui/useless-comment.stderr
@@ -2,7 +2,7 @@ error: unused doc comment
   --> $DIR/useless-comment.rs:9:1
    |
 LL | /// foo
-   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macros
+   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macro invocations
    |
 note: the lint level is defined here
   --> $DIR/useless-comment.rs:3:9
@@ -15,7 +15,7 @@ error: unused doc comment
   --> $DIR/useless-comment.rs:32:5
    |
 LL |     /// bar
-   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macros
+   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macro invocations
    |
    = help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion
 

Original file line number	Diff line number	Diff line change
`@@ -566,7 +566,7 @@ pub trait LintContext: Sized {`
`566`	`566`	`stability::deprecation_suggestion(&mut db, suggestion, span)`
`567`	`567`	`}`
`568`	`568`	`BuiltinLintDiagnostics::UnusedDocComment(span) => {`
`569`		`- db.span_label(span, "rustdoc does not generate documentation for macros");`
	`569`	`+ db.span_label(span, "rustdoc does not generate documentation for macro invocations");`
`570`	`570`	`db.help("to document an item produced by a macro, \`
`571`	`571`	`the macro must produce the documentation as part of its expansion");`
`572`	`572`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ error: unused doc comment`
`2`	`2`	`--> $DIR/useless-comment.rs:9:1`
`3`	`3`	`\|`
`4`	`4`	`LL \| /// foo`
`5`		`- \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macros`
	`5`	`+ \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macro invocations`
`6`	`6`	`\|`
`7`	`7`	`note: the lint level is defined here`
`8`	`8`	`--> $DIR/useless-comment.rs:3:9`
`@@ -15,7 +15,7 @@ error: unused doc comment`
`15`	`15`	`--> $DIR/useless-comment.rs:32:5`
`16`	`16`	`\|`
`17`	`17`	`LL \| /// bar`
`18`		`- \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macros`
	`18`	`+ \| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ rustdoc does not generate documentation for macro invocations`
`19`	`19`	`\|`
`20`	`20`	`= help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion`
`21`	`21`