diff --git a/src/error.rs b/src/error.rs index a31bcc0..bfb86f5 100644 --- a/src/error.rs +++ b/src/error.rs @@ -22,6 +22,10 @@ use std::{ str, }; +//! Implements IrcStreamError, an error type +//! that wraps all possible error that are thrown by IrcStream. + +/// A custom error type that wraps all error that IrcStream will throw. #[derive(Debug)] pub enum IrcStreamError { Io(io::Error),