diff src/libpam/handle.rs @ 174:9e4ce1631bd3

Dramatically expand documentation.
author Paul Fisher <paul@pfish.zone>
date Tue, 29 Jul 2025 18:58:27 -0400
parents e27c5c667a5a
children e30775c80b49
line wrap: on
line diff
--- a/src/libpam/handle.rs	Tue Jul 29 16:52:32 2025 -0400
+++ b/src/libpam/handle.rs	Tue Jul 29 18:58:27 2025 -0400
@@ -44,6 +44,9 @@
     }
 }
 
+/// Builder to start a [`LibPamTransaction`].
+///
+/// Use [`Self::new_with_service`] to build a new PAM transaction.
 #[derive(Debug, PartialEq)]
 pub struct TransactionBuilder {
     service_name: OsString,
@@ -57,6 +60,9 @@
     /// when authenticating a user. This corresponds to the configuration file
     /// usually at <code>/etc/pam.d/<var>service_name</var></code>.
     ///
+    /// You usually want to call [`username`](Self::username) to set
+    /// the username before starting the transaction.
+    ///
     /// # References
     #[doc = linklist!(pam_start: adg, _std)]
     ///
@@ -132,7 +138,6 @@
     ///
     /// On other platforms, this is no different than letting the transaction
     /// end on its own.
-    ///
     #[doc = man7!(3 pam_end)]
     pub fn end_silent(self) {
         #[cfg(pam_impl = "LinuxPam")]