Documented panic condition for client registration with a reactor.

This commit is contained in:
Aaron Weiss 2018-05-14 20:53:06 +02:00
parent 5bd349f8ff
commit 7d8feafb52
No known key found for this signature in database
GPG key ID: 047D32DF25DC22EF

View file

@ -122,6 +122,8 @@ impl IrcReactor {
/// connection indefinitely (or until failure). As registration is consumed by `run`, subsequent /// connection indefinitely (or until failure). As registration is consumed by `run`, subsequent
/// calls to run will require new registration. /// calls to run will require new registration.
/// ///
/// **Note**: A client can only be registered once. Subsequent attempts will cause a panic.
///
/// # Example /// # Example
/// ```no_run /// ```no_run
/// # extern crate irc; /// # extern crate irc;