about summary refs log tree commit diff
path: root/util
diff options
context:
space:
mode:
Diffstat (limited to 'util')
-rw-r--r--util/src/lib.rs8
-rw-r--r--util/src/micropub.rs3
2 files changed, 7 insertions, 4 deletions
diff --git a/util/src/lib.rs b/util/src/lib.rs
index f92ee1b..cb5f666 100644
--- a/util/src/lib.rs
+++ b/util/src/lib.rs
@@ -22,13 +22,13 @@ pub enum MentionType {
 
 /// Common data-types useful in creating smart authentication systems.
 pub mod auth {
+    /// Various types of credentials Kittybox can use.
     #[derive(PartialEq, Eq, Hash, Clone, Copy)]
     pub enum EnrolledCredential {
-        /// An indicator that a password is enrolled. Passwords can be
-        /// used to recover from a lost token.
+        /// Denotes availability of a password. Passwords can be
+        /// used to recover from a lost passkey.
         Password,
-        /// An indicator that one or more WebAuthn credentials were
-        /// enrolled.
+        /// Denotes availability of one or more passkeys.
         WebAuthn
     }
 }
diff --git a/util/src/micropub.rs b/util/src/micropub.rs
index ce9e2d7..6127079 100644
--- a/util/src/micropub.rs
+++ b/util/src/micropub.rs
@@ -1,3 +1,6 @@
+//! Common protocol types for Micropub.
+//!
+//! Check out the [`kittybox-indieauth`] crate that gives similar treatment to IndieAuth.
 use std::collections::HashMap;
 
 use serde::{Deserialize, Serialize};