Explain the E data type

IntersectMBO · Aug 9, 2023 · 600eabb · 600eabb
1 parent 049bcc4
commit 600eabb
Showing 1 changed file with 12 additions and 2 deletions.
diff --git a/ouroboros-consensus/src/consensus-testlib/Test/Ouroboros/Consensus/ChainGenerator/Slot.hs b/ouroboros-consensus/src/consensus-testlib/Test/Ouroboros/Consensus/ChainGenerator/Slot.hs
@@ -87,8 +87,18 @@ showS (S bool) = showChar $ if bool then '1' else '0'
 
 -----
 
--- | The different kinds of element counted in this library
-data E = ActiveSlotE | EmptySlotE | SlotE
+-- | Type-level names for the different kinds of slots counted in this library
+--
+-- The data constructors of this type are used in promoted form with
+-- @-XDataKinds@.
+--
+data E =
+     -- ^ Active slots are those where at least one must be created
+     ActiveSlotE
+     -- ^ Empty slots are those where no block shall be created
+   | EmptySlotE
+     -- ^ SlotE denotes slots that can be either active or empty
+   | SlotE
 
 inverted :: Proxy Inverted
 inverted = Proxy