Skip to content

Improve must_use comment on RemoteHandle #2152

@Nemo157

Description

@Nemo157

#[must_use = "futures do nothing unless you `.await` or poll them"]

This is burying the lede, it seems more important to mention the behaviour on drop, which will cause many more issues if the handle is not used

/// [`remote_handle`](crate::future::FutureExt::remote_handle). When you drop this,
/// the remote future will be woken up to be dropped by the executor.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions