Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

macros: suppress clippy::needless_return and add docs #6874

Merged
merged 1 commit into from
Sep 28, 2024

Conversation

oxalica
Copy link
Contributor

@oxalica oxalica commented Sep 27, 2024

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)

It triggers the warning for nightly clippy (since about 2024-09-26), but
is actually intentional.
@Darksonn Darksonn added the A-tokio-macros Area: The tokio-macros crate label Sep 28, 2024
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@Darksonn Darksonn merged commit 2c14f88 into tokio-rs:master Sep 28, 2024
86 checks passed
@oxalica oxalica deleted the fix/warn-needless-return branch September 28, 2024 19:03
kodiakhq bot pushed a commit to pdylanross/fatigue that referenced this pull request Jan 13, 2025
⚠️  Dependabot is rebasing this PR ⚠️
Rebasing might not happen immediately, so don't worry if this takes some time.
Note: if you make any changes to this PR yourself, they will take precedence over the rebase.

Bumps tokio from 1.42.0 to 1.43.0.

Release notes
Sourced from tokio's releases.

Tokio v1.43.0
1.43.0 (Jan 8th, 2025)
Added

net: add UdpSocket::peek methods (#7068)
net: add support for Haiku OS (#7042)
process: add Command::into_std() (#7014)
signal: add SignalKind::info on illumos (#6995)
signal: add support for realtime signals on illumos (#7029)

Fixed

io: don't call set_len before initializing vector in Blocking (#7054)
macros: suppress clippy::needless_return in #[tokio::main] (#6874)
runtime: fix thread parking on WebAssembly (#7041)

Changes

chore: use unsync loads for unsync_load (#7073)
io: use Buf::put_bytes in Repeat read impl (#7055)
task: drop the join waker of a task eagerly (#6986)

Changes to unstable APIs

metrics: improve flexibility of H2Histogram Configuration (#6963)
taskdump: add accessor methods for backtrace (#6975)

Documented

io: clarify ReadBuf::uninit allows initialized buffers as well (#7053)
net: fix ambiguity in TcpStream::try_write_vectored docs (#7067)
runtime: fix LocalRuntime doc links (#7074)
sync: extend documentation for watch::Receiver::wait_for (#7038)
sync: fix typos in OnceCell docs (#7047)

#6874: tokio-rs/tokio#6874
#6963: tokio-rs/tokio#6963
#6975: tokio-rs/tokio#6975
#6986: tokio-rs/tokio#6986
#6995: tokio-rs/tokio#6995
#7014: tokio-rs/tokio#7014
#7029: tokio-rs/tokio#7029
#7038: tokio-rs/tokio#7038
#7041: tokio-rs/tokio#7041
#7042: tokio-rs/tokio#7042
#7047: tokio-rs/tokio#7047
#7053: tokio-rs/tokio#7053
#7054: tokio-rs/tokio#7054
#7055: tokio-rs/tokio#7055


... (truncated)


Commits

5f3296d chore: prepare Tokio v1.43.0 (#7079)
cc974a6 chore: prepare tokio-macros v2.5.0 (#7078)
15495fd metrics: improve flexibility of H2Histogram Configuration (#6963)
ad41834 io: don't call set_len before initializing vector in Blocking (#7054)
bd3e857 runtime: move is_join_waker_set assertion in unset_waker (#7072)
15f7366 runtime: fix LocalRuntime doc links (#7074)
fd2048d ci: split miri jobs into unit and integration tests (#7071)
e8f3915 chore: use unsync loads for unsync_load (#7073)
67f1277 net: fix ambiguity in TcpStream::try_write_vectored docs (#7067)
463502c io: clarify ReadBuf::uninit allows initialized buffers as well (#7053)
Additional commits viewable in compare view




Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio-macros Area: The tokio-macros crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clippy warns "unneeded return statement" for #[tokio::{main,test}] fns on latest nightly
2 participants