From 697e90f291cec1bbd89965c2731f9481ec4507c4 Mon Sep 17 00:00:00 2001
From: Owen Jacobson <owen@grimoire.ca>
Date: Wed, 25 Sep 2024 01:22:07 -0400
Subject: rustdoc comment for the (very limited) public API of the crate.

This silences some `-Wclippy::pedantic` warning, and it's just a good thing to do.

I've made the choice to have the docs comment face programmers, and to provide `hi --help` and `hi -h` content via Clap attributes instead of inferring it from the docs comment.

Internal (private) "rustdoc" comments have been converted to regular comments until I learn how to write better rustdoc.
---
 src/lib.rs | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/lib.rs')

diff --git a/src/lib.rs b/src/lib.rs
index a7ca18b..9071e51 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,5 @@
+//! `hi` - a web-based, self-hosted chat system.
+
 mod app;
 mod channel;
 pub mod cli;
-- 
cgit v1.2.3