Skip to content

Documentation for mpsc::Sender should reflect its Sync trait #114722

Closed
@MikeWalrus

Description

@MikeWalrus

Location

/// The sending-half of Rust's asynchronous [`channel`] type. This half can only be
/// owned by one thread, but it can be cloned to send to other threads.
///
/// Messages can be sent through this channel with [`send`].

Summary

Given that Sync is now implemented for Sender in #111087, the documentation for Sender should no longer mention that it's meant to be cloned. In my opinion, it's better to be consistent with the documentation for SyncSender, which has been Sync.

/// The sending-half of Rust's synchronous [`sync_channel`] type.
///
/// Messages can be sent through this channel with [`send`] or [`try_send`].

Metadata

Metadata

Assignees

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-libsRelevant to the library team, which will review and decide on the PR/issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions