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
signal: update documentation with caveats #1854
Merged
Merged
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
carllerche
reviewed
Nov 28, 2019
carllerche
reviewed
Nov 28, 2019
carllerche
reviewed
Nov 28, 2019
carllerche
reviewed
Nov 28, 2019
carllerche
approved these changes
Nov 28, 2019
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great 👍 approving, but it would be even more amazing w/ some examples :)
@carllerche examples have been added, let me know if you have other feedback :) |
carllerche
reviewed
Nov 28, 2019
carllerche
reviewed
Nov 28, 2019
Co-Authored-By: Carl Lerche <me@carllerche.com>
Co-Authored-By: Carl Lerche <me@carllerche.com>
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.
Motivation
{unix::Signal, windows::CtrlBreak}::{recv, poll_recv}
methods are undocumented and hiddenSolution
{unix::Signal, windows::CtrlBreak}::{recv, poll_recv}
methods so that callers don't need to depend on thefuture_core::Stream
trait if they don't want to