From 697e90f291cec1bbd89965c2731f9481ec4507c4 Mon Sep 17 00:00:00 2001 From: Owen Jacobson 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/login/repo/auth.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'src/login/repo') diff --git a/src/login/repo/auth.rs b/src/login/repo/auth.rs index 78b44f0..3033c8f 100644 --- a/src/login/repo/auth.rs +++ b/src/login/repo/auth.rs @@ -18,9 +18,9 @@ impl<'c> Provider for Transaction<'c, Sqlite> { pub struct Auth<'t>(&'t mut SqliteConnection); impl<'t> Auth<'t> { - /// Retrieves a login by name, plus its stored password hash for - /// verification. If there's no login with the requested name, this will - /// return [None]. + // Retrieves a login by name, plus its stored password hash for + // verification. If there's no login with the requested name, this will + // return [None]. pub async fn for_name( &mut self, name: &str, -- cgit v1.2.3