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/error.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'src/error.rs')

diff --git a/src/error.rs b/src/error.rs
index e2128d3..ffc90e9 100644
--- a/src/error.rs
+++ b/src/error.rs
@@ -40,7 +40,7 @@ impl IntoResponse for InternalError {
     }
 }
 
-/// Transient identifier for an InternalError. Prefixed with `E`.
+// Transient identifier for an InternalError. Prefixed with `E`.
 #[derive(Debug)]
 pub struct Id(BaseId);
 
-- 
cgit v1.2.3