add some small doc comments

This commit is contained in:
Michael Zhang 2021-02-24 04:52:32 -06:00
parent 5438bb170d
commit 5b3bf5dd3c
Signed by: michael
GPG key ID: BDA47A31A3C8EE6B
5 changed files with 14 additions and 2 deletions

View file

@ -1,7 +1,7 @@
panorama 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). Panorama is a terminal Personal Information Manager (PIM).

View file

@ -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] #[macro_use]
extern crate anyhow; extern crate anyhow;
#[macro_use] #[macro_use]

View file

@ -1,3 +1,5 @@
//! Module that implements parsers for all of the IMAP types.
use std::fmt::Debug; use std::fmt::Debug;
use std::str::FromStr; use std::str::FromStr;

View file

@ -1,3 +1,5 @@
//! Structs and enums that have to do with responses.
use std::ops::RangeInclusive; use std::ops::RangeInclusive;
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]

View file

@ -5,7 +5,7 @@ use std::path::{Path, PathBuf};
use anyhow::Result; use anyhow::Result;
use fern::colors::{Color, ColoredLevelConfig}; 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 panorama::{config::spawn_config_watcher_system, mail, report_err, ui};
use structopt::StructOpt; use structopt::StructOpt;
use tokio::{runtime::Runtime, sync::mpsc}; use tokio::{runtime::Runtime, sync::mpsc};