From c0b47b1fbc3c06ec4832c93796dd96b7a1a38247 Mon Sep 17 00:00:00 2001
From: Youwen Wu <youwenw@gmail.com>
Date: Thu, 12 Sep 2024 00:48:26 -0700
Subject: [PATCH] docs: add some top level module documentation

---
 src/lib.rs       | 2 ++
 src/libcanvas.rs | 5 +++--
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/lib.rs b/src/lib.rs
index 90f8901..8cbc006 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,2 +1,4 @@
+//! A TUI Canvas client. Also implements [libcanvas](./libcanvas/index.html), an ergonomic Rust wrapper around
+//! common Canvas API operations.
 pub mod libcanvas;
 pub use reqwest::Url;
diff --git a/src/libcanvas.rs b/src/libcanvas.rs
index 6be48f7..bdb03bf 100644
--- a/src/libcanvas.rs
+++ b/src/libcanvas.rs
@@ -1,6 +1,7 @@
+//! An ergonomic Rust wrapper around the Canvas API. Built for Cartographer, but can also be used
+//! in other projects.
 use reqwest::header;
-use reqwest::Url;
-use reqwest::{Client, Error};
+use reqwest::{Client, Error, Url};
 use std::env;
 pub mod courses;