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

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

Closed
MikeWalrus opened this issue Aug 11, 2023 · 1 comment · Fixed by #114749
Closed

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

MikeWalrus opened this issue Aug 11, 2023 · 1 comment · Fixed by #114749
Assignees
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@MikeWalrus
Copy link
Contributor

MikeWalrus commented Aug 11, 2023

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`].

@MikeWalrus MikeWalrus added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Aug 11, 2023
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Aug 11, 2023
@saethlin saethlin added T-libs Relevant to the library team, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Aug 11, 2023
@gurry
Copy link
Contributor

gurry commented Aug 12, 2023

@rustbot claim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants