Skip to content

Commit b300f00

Browse files
committed
Adjust do_not_recommend intro to use the attribute template
1 parent 9571d4d commit b300f00

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/attributes/diagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ r[attributes.diagnostic.do_not_recommend]
553553
### The `diagnostic::do_not_recommend` attribute
554554

555555
r[attributes.diagnostic.do_not_recommend.intro]
556-
The `#[diagnostic::do_not_recommend]` attribute is a hint to the compiler to not show the annotated trait implementation as part of a diagnostic message.
556+
The *`diagnostic::do_not_recommend` [attribute][attributes]* is a hint to the compiler to not show the annotated trait implementation as part of a diagnostic message.
557557

558558
> [!NOTE]
559559
> Suppressing the recommendation can be useful if you know that the recommendation would normally not be useful to the programmer. This often occurs with broad, blanket impls. The recommendation may send the programmer down the wrong path, or the trait implementation may be an internal detail that you don't want to expose, or the bounds may not be able to be satisfied by the programmer.

0 commit comments

Comments
 (0)