From 78a32ebeceb564644fe4772607afc6499ed71922 Mon Sep 17 00:00:00 2001
From: Lennart Spitzner <hexagoxel@hexagoxel.de>
Date: Fri, 4 Mar 2022 14:34:32 +0000
Subject: [PATCH] Add some code comments

---
 src-hxbrief/Main.hs | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/src-hxbrief/Main.hs b/src-hxbrief/Main.hs
index 51ff482..1422ad7 100644
--- a/src-hxbrief/Main.hs
+++ b/src-hxbrief/Main.hs
@@ -86,13 +86,13 @@ data StreamKind = StdOut | StdErr
   deriving (Eq, Show)
 
 data JoinMode
-  = JoinYield
-  | JoinAll
-  | JoinSpecific
+  = JoinYield    -- i.e. don't join: We want to yield that exact line
+  | JoinAll      -- join with any other JoinAll-tagged lines/patterns
+  | JoinSpecific -- join with this pattern only
 
 data JoinedInfo
-  = JoinedNot
-  | JoinedYield
+  = JoinedNot     -- Line did not match any pattern
+  | JoinedYield   -- Line matched a yield pattern, must be forwarded as-is
   | JoinedAll Int
   | Joined Int String [String] -- pattern, prefix