Add documentation for #[diagnostic::do_not_recommend]
#1663
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ehuss
added
the
S-waiting-on-stabilization
ehuss
reviewed
Oct 24, 2024
| @@ -492,6 +492,47 @@ error[E0277]: My Message for `ImportantTrait<i32>` implemented for `String` | |||
| = note: Note 2 | |||
| ``` | |||
|
|
|||
| ### The `diagnostic::do_not_recommend` attribute | |||
|
|
|||
| The `#[diagnostic::on_unimplemented]` attribute is a hint to the compiler to not show a certain trait implementation as part of the error message. | |||
There was a problem hiding this comment.
Can this explain a little more what error this is referring to, and what circumstances it will avoid showing an error?
There was a problem hiding this comment.
Can this explain a little more what error this is referring to
Currently this is mostly relevant for E0277, although that might change in the future?
and what circumstances it will avoid showing an error?
It never avoids showing an error, it just changes the content of the error message to not mention/consider certain trait implementations if somewhat reasonable possible.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for rust-lang/rust#132056