refactor(lib): Make haddock easier to read

app/Main.hs

@@ -3,7 +3,6 @@ module Main (main) where
 import Data.Gibberish
 import Data.Gibberish.Formatting qualified as Fmt
 
-import Control.Monad.IO.Class (MonadIO (..))
 import Data.Text (Text ())
 import Data.Text qualified as Text
 import Data.Text.IO qualified as Text
@@ -12,7 +11,6 @@ import Options.Applicative hiding (columns)
 import Options.Applicative.Help.Pretty
 import PackageInfo_gibberish (name, version)
 import System.Environment (getArgs)
-import System.Random (RandomGen (..), getStdGen)
 import Prelude hiding (Word ())
 
 termLen :: Int

src/Data/Gibberish.hs

@@ -1,48 +1,53 @@
 module Data.Gibberish
-  ( -- * Core types
-    GenPasswordOpts (..),
-    GenPassphraseOpts (..),
-    Unigram (..),
-    Digram (..),
-    Trigram (..),
-    Frequency (..),
-    Frequencies (..),
-    Trigraph (..),
-    Word (..),
-
-    -- * Password/phrase generation
+  ( -- * Generating Passwords
     genPassword,
     genPasswords,
     genPasswords',
+
+    -- * Generating Passphrases
     genPassphrase,
     genPassphrase',
 
-    -- * Trigraph generation
-    Language (..),
-    TrigraphConfig (..),
-    genTrigraph,
-    loadTrigraph,
-
-    -- * Password/phrase generation monad
+    -- * The Pass Monad
     Pass (),
-    PassT (..),
-    MonadRandom (..),
     runPass,
     evalPass,
     usingPass,
+
+    -- * The PassT Monad Transformer
+    PassT (..),
     runPassT,
     evalPassT,
     usingPassT,
+    module Control.Monad.Random,
 
-    -- * Error handling
+    -- * Core Types
+    GenPasswordOpts (..),
+    GenPassphraseOpts (..),
+    Language (..),
+    TrigraphConfig (..),
+    Trigraph (..),
+    Word (..),
+    Unigram (..),
+    Digram (..),
+    Trigram (..),
+    Frequency (..),
+    Frequencies (..),
+
+    -- * Error Handling
     GibberishErr (..),
     isTrigraphNotFound,
     isImpossibleError,
+
+    -- * Working with Trigraphs
+    genTrigraph,
+    loadTrigraph,
   ) where
 
 import Data.Gibberish.Errors
 import Data.Gibberish.Gen
 import Data.Gibberish.Monad.Pass
 import Data.Gibberish.Types
 
+import Control.Monad.Random
 import Prelude hiding (Word ())

src/Data/Gibberish/Gen/Trigraph.hs

@@ -1,21 +1,19 @@
 {-# LANGUAGE OverloadedLists #-}
 
 module Data.Gibberish.Gen.Trigraph
-  ( Language (..),
-    TrigraphConfig (..),
-    genTrigraph,
+  ( genTrigraph,
     loadTrigraph,
   ) where
 
 import Data.Gibberish.Errors (GibberishErr (..))
+import Data.Gibberish.Types
 import Data.Gibberish.Utils (toQwertyKey)
 import Paths_gibberish (getDataFileName)
 
 import Control.Exception (throwIO)
 import Control.Monad (unless)
 import Data.Aeson qualified as Aeson
 import Data.Char (isPunctuation, toLower)
-import Data.Gibberish.Types
 import Data.Map.Strict (Map ())
 import Data.Map.Strict qualified as Map
 import Data.Maybe (fromJust)
@@ -24,16 +22,6 @@ import Data.Text qualified as Text
 import System.Directory (doesFileExist)
 import System.FilePath ((</>))
 
-data Language
-  = English
-  | Spanish
-  | CustomTrigraph TrigraphConfig
-  deriving stock (Eq, Show)
-
-newtype TrigraphConfig = TrigraphConfig
-  {unTrigraphConfig :: FilePath}
-  deriving stock (Eq, Show)
-
 -- | Generate trigraphs from a list of words
 genTrigraph :: [Text] -> Trigraph
 genTrigraph = Trigraph . foldr (foldWord . normalizeWord) Map.empty

src/Data/Gibberish/Monad/Pass.hs

@@ -1,18 +1,16 @@
 module Data.Gibberish.Monad.Pass
   ( Pass (),
     PassT (..),
-    MonadRandom (..),
     runPass,
     evalPass,
     usingPass,
     runPassT,
     evalPassT,
     usingPassT,
+    module Control.Monad.Random,
   ) where
 
-import Control.Monad.IO.Class (MonadIO ())
-import Control.Monad.Random (MonadRandom (..))
-import Control.Monad.Trans.Random (RandT (), evalRandT, runRandT)
+import Control.Monad.Random
 import Data.Functor.Identity (Identity (..))
 
 -- | Password/Passphrase generation monad parameterized by the type @gen@ of the generator

src/Data/Gibberish/Types.hs

@@ -3,6 +3,8 @@
 module Data.Gibberish.Types
   ( GenPasswordOpts (..),
     GenPassphraseOpts (..),
+    Language (..),
+    TrigraphConfig (..),
     Unigram (..),
     Digram (..),
     Trigram (..),
@@ -54,6 +56,18 @@ data GenPassphraseOpts = GenPassphraseOpts
   }
   deriving stock (Eq, Show)
 
+-- | A language indicating the dictionary that generated a trigraph
+data Language
+  = English
+  | Spanish
+  | CustomTrigraph TrigraphConfig
+  deriving stock (Eq, Show)
+
+-- | A path to a trigraph json config file
+newtype TrigraphConfig = TrigraphConfig
+  {unTrigraphConfig :: FilePath}
+  deriving stock (Eq, Show)
+
 -- | A unigram is a single letter
 newtype Unigram = Unigram {unUnigram :: Char}
   deriving stock (Eq, Ord, Show)

test/Data/Gibberish/Gen/PassSpec.hs

@@ -1,7 +1,7 @@
 module Data.Gibberish.Gen.PassSpec (spec) where
 
 import Data.Gibberish.Gen.Pass
-import Data.Gibberish.Gen.Trigraph (Language (..), loadTrigraph)
+import Data.Gibberish.Gen.Trigraph (loadTrigraph)
 import Data.Gibberish.Monad.Pass (usingPass, usingPassT)
 import Data.Gibberish.Types
 import Data.Gibberish.Utils (numeralConversions, symbolConversions)