sync: improve the docs of sync::watch
#7601
Merged
Conversation
This file contains hidden or 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
Since `watch` is a multi-producer channel its documentation should talk about many/all Senders. RecvError will be returned only when all senders are dropped
|
Done! I applied the commit from #7600 here |
|
Changed to Draft because it seems there are more doc items to update |
…ed only when all senders and all receivers are dropped
Darksonn
added
T-docs
…be set only when all senders of the channel are dropped
…s in the channel are dropped
…ht be more than one senders in the channel
…osed only when all senders in the watch channel are closed
martin-g
force-pushed
the
RecvError-if-all-senders-are-dropped
branch
from
1d6458b to
c60f83e
Compare
|
The PR is ready for review. |
Darksonn
reviewed
Sep 10, 2025
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
ADD-SP
changed the title
sync::watch
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Motivation
Since
watchis a multi-producer channel its documentation should talk about many/all Senders.Solution
Update the documentation for Receiver::changed() that RecvError will be returned only when all senders are dropped.