fix doc for std::sync::mpmc #135876
Merged
fix doc for std::sync::mpmc #135876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rustbot
added
S-waiting-on-review
tgross35
reviewed
Jan 25, 2025
library/std/src/sync/mpmc/mod.rs
Outdated
Comment on lines
363
to
366
| /// hang up immediately after this function returns [`Ok`]. If the channel | ||
| /// is zero-capacity, however, the channel becomes a rendezvous channel and | ||
| /// it guarantees that the receiver has indeed received the data if this | ||
| /// function returns success. |
There was a problem hiding this comment.
This wording is a bit tricky. Maybe something like "However, if the channel is zero-capacity, it acts as a rendezvous channel and an Ok(()) result indicates the data was successfully received" or similar.
Otherwise LGTM.
There was a problem hiding this comment.
Now changed to
However, if the channel is zero-capacity, it acts as a rendezvous channel and a
return value of [`Ok`] means that the data is successfully received.
There was a problem hiding this comment.
Thanks, looks good with one nit: could you change "is successfully received" to "has been" or "was"?
After that please squash then r=me.
tgross35
approved these changes
Jan 27, 2025
|
Thanks! @bors r+ rollup |
bors
added
S-waiting-on-bors
Zalathar
added a commit
to Zalathar/rust
that referenced
this pull request
Jan 27, 2025
fix doc for std::sync::mpmc fix document of `std::sync::mpmc` (tracked in rust-lang#126840)
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 27, 2025
Rollup of 6 pull requests Successful merges: - rust-lang#135876 (fix doc for std::sync::mpmc) - rust-lang#135961 (Fix 2/4 tests skipped by opt-dist) - rust-lang#136037 (Mark all NuttX targets as tier 3 target and support the standard library) - rust-lang#136098 (Downgrade `linker-warnings` to allow-by-default) - rust-lang#136110 (Miri subtree update) - rust-lang#136117 (Subtree update of `rust-analyzer`) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 27, 2025
Rollup of 6 pull requests Successful merges: - rust-lang#135876 (fix doc for std::sync::mpmc) - rust-lang#135961 (Fix 2/4 tests skipped by opt-dist) - rust-lang#136037 (Mark all NuttX targets as tier 3 target and support the standard library) - rust-lang#136098 (Downgrade `linker-warnings` to allow-by-default) - rust-lang#136110 (Miri subtree update) - rust-lang#136117 (Subtree update of `rust-analyzer`) r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 27, 2025
…llaumeGomez Rollup of 10 pull requests Successful merges: - rust-lang#135773 (Clarify WindowsMut (Lending)Iterator) - rust-lang#135807 (Implement phantom variance markers) - rust-lang#135876 (fix doc for std::sync::mpmc) - rust-lang#135988 (Add a workaround for parallel rustc crashing when there are delayed bugs) - rust-lang#136037 (Mark all NuttX targets as tier 3 target and support the standard library) - rust-lang#136064 (Add a suggestion to cast target_feature fn items to fn pointers.) - rust-lang#136082 (Incorporate `iter_nodes` into `graph::DirectedGraph`) - rust-lang#136112 (Clean up all dead files inside `tests/ui/`) - rust-lang#136114 (Use identifiers more in diagnostics code) - rust-lang#136118 (Change `collect_and_partition_mono_items` tuple return type to a struct) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jan 27, 2025
Rollup merge of rust-lang#135876 - usamoi:mpmc-doc, r=tgross35 fix doc for std::sync::mpmc fix document of `std::sync::mpmc` (tracked in rust-lang#126840)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
fix document of
std::sync::mpmc(tracked in #126840)