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

signal: update documentation with caveats #1854

Merged
merged 4 commits into from Nov 28, 2019
Merged

signal: update documentation with caveats #1854

merged 4 commits into from Nov 28, 2019

Conversation

ipetkov
Copy link
Member

@ipetkov ipetkov commented Nov 28, 2019

Motivation

Solution

  • Update the module and method docs with any relevant platform-specific caveats
  • Publicly document the {unix::Signal, windows::CtrlBreak}::{recv, poll_recv} methods so that callers don't need to depend on the future_core::Stream trait if they don't want to

Copy link
Member

@carllerche carllerche left a 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 :)

@ipetkov
Copy link
Member Author

ipetkov commented Nov 28, 2019

@carllerche examples have been added, let me know if you have other feedback :)

ipetkov and others added 2 commits November 28, 2019 14:41
Co-Authored-By: Carl Lerche <me@carllerche.com>
Co-Authored-By: Carl Lerche <me@carllerche.com>
@carllerche carllerche merged commit aef434c into tokio-rs:master Nov 28, 2019
@ipetkov ipetkov deleted the signal-dox branch November 28, 2019 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants