From 4d656ff54ddbd0ddbe4a09598e022681e9489dad Mon Sep 17 00:00:00 2001
From: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
Date: Mon, 16 Dec 2019 19:35:00 +0000
Subject: [PATCH] logging: Described the design

---
 src/logging.rs | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/src/logging.rs b/src/logging.rs
index 79244d77..dcddb0c2 100644
--- a/src/logging.rs
+++ b/src/logging.rs
@@ -1,8 +1,41 @@
-/*! Logging library */
+/*! Logging library.
+ * 
+ * This is probably the only part of squeekboard
+ * that should be doing any direct printing.
+ * 
+ * There are several approaches to logging,
+ * in the order of increasing flexibility and/or purity:
+ * 
+ * 1. `println!` directly
+ * 
+ *   It can't be easily replaced by a different solution
+ * 
+ * 2. simple `log!` macro
+ * 
+ *   Replacing the destination at runtime other than globally would be awkward,
+ *   so no easy way to suppress errors for things that don't matter,
+ *   but formatting is still easy.
+ * 
+ * 3. logging to a mutable destination type
+ * 
+ *   Can be easily replaced, but logging `Result` types,
+ *   which should be done by calling a method on the result,
+ *   can't be formatted directly.
+ *   Cannot be parallelized.
+ * 
+ * 4. logging to an immutable destination type
+ * 
+ *   Same as above, except it can be parallelized.
+ *   It seems more difficult to pass the logger around,
+ *   but this may be a solved problem from the area of functional programming.
+ * 
+ * This library generally aims at the approach in 3.
+ * */
 
 use std::error::Error;
 
-/// Sugar for logging errors in results
+/// Sugar for logging errors in results.
+/// Approach 2.
 pub trait Warn {
     type Value;
     fn ok_warn(self, msg: &str) -> Option<Self::Value>;
@@ -18,6 +51,8 @@ impl<T, E: Error> Warn for Result<T, E> {
     }
 }
 
+/// A mutable handler for text warnings.
+/// Approach 3.
 pub trait WarningHandler {
     /// Handle a warning
     fn handle(&mut self, warning: &str);