Documentation: document panic in oneshot::Receiver::try_recv #3671
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
When initially consulting the docs I assumed the channel would report as closed after the value was sent and received partially due to not noticing any mention of panics. I had a look through the module and Receiver docs for oneshot and didn't find mention of the panic so updated the receiver docs accordingly.
Darksonn
added
A-tokio
|
Closing in favor of #3674 |
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.
When initially consulting the docs I assumed the channel would report as closed after the value was sent and received partially due to not noticing any mention of panics. I had a look through the module and Receiver docs for oneshot and didn't find mention of the panic so updated the receiver docs accordingly.