More PR Feedback

Author: trevarj

crates/libtiny_client/src/lib.rs

@@ -64,8 +64,8 @@ pub struct ServerInfo {
 }
 
 /// SASL authentication mechanisms
-/// https://ircv3.net/docs/sasl-mechs
-/// https://www.alphachat.net/sasl.xhtml
+/// - <https://ircv3.net/docs/sasl-mechs>
+/// - <https://www.alphachat.net/sasl.xhtml>
 #[derive(Debug, Clone)]
 pub enum SASLAuth {
     Plain { username: String, password: String },

crates/libtiny_client/src/state.rs

@@ -648,6 +648,7 @@ impl StateInner {
                 }
             }
 
+            // https://ircv3.net/specs/extensions/sasl-3.1.html
             AUTHENTICATE { ref param } => {
                 if param.as_str() == "+" {
                     // Empty AUTHENTICATE response; server accepted the specified SASL mechanism
@@ -657,6 +658,7 @@ impl StateInner {
                                 let msg = format!("{}\x00{}\x00{}", username, username, password);
                                 base64::encode(&msg)
                             }
+                            // Reply with an empty response (Empty responses are sent as "AUTHENTICATE +")
                             SASLAuth::External { .. } => "+".to_string(),
                         };
                         snd_irc_msg.try_send(wire::authenticate(&msg)).unwrap();

crates/tiny/config.yml

@@ -32,7 +32,7 @@ servers:
       #   username: 'tiny_user'
       #   password: 'hunter2'
       # OR
-      #   pem: "/home/.config/tiny/oftc.pem"
+      #   pem: "/home/user/.config/tiny/oftc.pem"
 
       # Identify nick by sending a message to NickServ:
       # (useful when `pass` or `sasl` fields above are not used)

crates/tiny/src/main.rs

@@ -204,7 +204,8 @@ fn sasl_from_config(tls: bool, sasl_config: &config::SASLAuth) -> Result<SASLAut
         config::SASLAuth::External { pem } => {
             // TLS must be on for EXTERNAL
             if !tls {
-                Err("TLS is not enabled for this server, but SASL EXTERNAL authentication requires SASL. Please enable SASL for this server in the config file.".to_string())
+                Err("TLS is not enabled for this server, but SASL EXTERNAL authentication requires SASL. \
+                Please enable SASL for this server in the config file.".to_string())
             } else {
                 // load in a cert and private key for TLS client auth
                 match File::open(pem) {