fix: stop dead branch in proc macro from emitting clippy::missing_panics_doc #3595
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
humb1t
approved these changes
Nov 25, 2024
abonander
reviewed
Nov 26, 2024
| ::std::panic!(); | ||
| // `panic!` would be enough here but we would then get a warning on `clippy::missing_panics_doc` | ||
| // SAFETY: this branch is never reached. | ||
| unsafe { ::std::hint::unreachable_unchecked() } |
There was a problem hiding this comment.
I don't like emitting unsafe from the macros for any reason, honestly. Does unreachable!() emit the same lint warning?
There was a problem hiding this comment.
Alternatively, just #[allow] the lint.
There was a problem hiding this comment.
This is effectively identical.
The compiler should be able to figure out that anything in if false {...} is unreachable ^^
Though I think clippy should also alert for this (it is still a panic just with a better name. If clippy is not, this is a false negative).
Suggested change
| unsafe { ::std::hint::unreachable_unchecked() } | |
| #[allow(clippy::missing_panics_doc)] | |
| ::std::unreachable!(); |
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.
fixes #3594