macros: suppress clippy::needless_return and add docs #6874
+2
−1
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.
Motivation
Fixes #6869: nightly clippy warns on any
#[tokio::{main,test}]
.Solution
#[allow(clippy::needless_return)]
to suppress that clippy warning. Ideally clippy should allow it for macro generated code, but we have no idea how long it would take to do that.Also document the reason why we are using a
return
instead of a tail expression.Tested to work for
1.83.0-nightly (2bd1e894e 2024-09-26)