Merge pull request #247 from twmb/timeout_token_doc

TokenTimeout: add doc around new panic
This commit is contained in:
Alex Crichton 2017-09-09 14:21:30 -05:00 committed by GitHub
commit 645ae7051d

View File

@ -48,7 +48,7 @@ impl TimeoutToken {
/// # Panics
///
/// This method will panic if the timeout specified was not created by this
/// loop handle's `add_timeout` method.
/// loop handle's `add_timeout` method or if called multiple times.
pub fn cancel_timeout(&self, handle: &Remote) {
debug!("cancel timeout {}", self.token);
handle.send(Message::CancelTimeout(self.token))