From b23709917ea21a48eadb8836fa102aeb45fea64e Mon Sep 17 00:00:00 2001
From: Thelie <git.daniel@mowitz.rocks>
Date: Wed, 5 May 2021 19:45:39 +0200
Subject: [PATCH] Update 'src/error.rs'

Added doc comments.
---
 src/error.rs | 4 ++++
 1 file changed, 4 insertions(+)

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),