From 5b3bf5dd3c9c495fb617cab5e4652b1f4623022e Mon Sep 17 00:00:00 2001
From: Michael Zhang <mail@mzhang.io>
Date: Wed, 24 Feb 2021 04:52:32 -0600
Subject: [PATCH] add some small doc comments

---
 README.md                | 2 +-
 imap/src/lib.rs          | 8 ++++++++
 imap/src/parser/mod.rs   | 2 ++
 imap/src/response/mod.rs | 2 ++
 src/main.rs              | 2 +-
 5 files changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c8f1b68..d105757 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 panorama
 ========
 
-[![](https://tokei.rs/b1/github/iptq/panorama?category=lines)](https://github.com/XAMPPRocky/tokei)
+[![](https://tokei.rs/b1/github/iptq/panorama?category=code)](https://github.com/XAMPPRocky/tokei)
 
 Panorama is a terminal Personal Information Manager (PIM).
 
diff --git a/imap/src/lib.rs b/imap/src/lib.rs
index 19dbf35..5ca59c0 100644
--- a/imap/src/lib.rs
+++ b/imap/src/lib.rs
@@ -1,3 +1,11 @@
+//! Panorama/IMAP
+//! ===
+//!
+//! This is a library that implements the IMAP protocol according to RFC 3501 and several
+//! extensions. Although its primary purpose is to be used in panorama, it should be usable for
+//! general-purpose IMAP usage. See the [client][crate::client] module for more information on how
+//! to get started with a client quickly.
+
 #[macro_use]
 extern crate anyhow;
 #[macro_use]
diff --git a/imap/src/parser/mod.rs b/imap/src/parser/mod.rs
index d86a5d8..f264004 100644
--- a/imap/src/parser/mod.rs
+++ b/imap/src/parser/mod.rs
@@ -1,3 +1,5 @@
+//! Module that implements parsers for all of the IMAP types.
+
 use std::fmt::Debug;
 use std::str::FromStr;
 
diff --git a/imap/src/response/mod.rs b/imap/src/response/mod.rs
index 3c16e54..c54127f 100644
--- a/imap/src/response/mod.rs
+++ b/imap/src/response/mod.rs
@@ -1,3 +1,5 @@
+//! Structs and enums that have to do with responses.
+
 use std::ops::RangeInclusive;
 
 #[derive(Clone, Debug, PartialEq, Eq)]
diff --git a/src/main.rs b/src/main.rs
index 77b4a72..1b93c41 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -5,7 +5,7 @@ use std::path::{Path, PathBuf};
 
 use anyhow::Result;
 use fern::colors::{Color, ColoredLevelConfig};
-use futures::future::{FutureExt, TryFutureExt};
+use futures::future::TryFutureExt;
 use panorama::{config::spawn_config_watcher_system, mail, report_err, ui};
 use structopt::StructOpt;
 use tokio::{runtime::Runtime, sync::mpsc};