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.

1 files changed, 1 insertions, 1 deletions

diff --git a/src/main.rs b/src/main.rs
index d199a74..d0830ff 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -3,7 +3,7 @@ use clap::Parser;
 use hi::cli;
 
 #[tokio::main]
-async fn main() -> cli::Result<()> {
+async fn main() -> Result<(), cli::Error> {
     let args = cli::Args::parse();
     args.run().await
 }