diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-09-25 01:22:07 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-09-25 02:15:25 -0400 |
| commit | 697e90f291cec1bbd89965c2731f9481ec4507c4 (patch) | |
| tree | b40ef7142da474b0ad2bd370b2c89d2008570976 /src/login/repo | |
| parent | af7ece7dd5433051d67526ae15ad64f0f5b5e568 (diff) | |
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.
Diffstat (limited to 'src/login/repo')
| -rw-r--r-- | src/login/repo/auth.rs | 6 |
1 files changed, 3 insertions, 3 deletions
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, |