Add/fix module Haddock documentation

commercialhaskell · Dec 1, 2023 · 5f4ec45 · 5f4ec45
1 parent 1ec13c4
commit 5f4ec45
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 10 deletions.
diff --git a/src/Stack/Types/Build/ConstructPlan.hs b/src/Stack/Types/Build/ConstructPlan.hs
@@ -1,17 +1,19 @@
 {-# LANGUAGE NoImplicitPrelude #-}
 
+-- | A module providing types and related helper functions used in module
+-- "Stack.Build.ConstructPlan".
 module Stack.Types.Build.ConstructPlan
-  ( ToolWarning (..)
-  , UnregisterState (..)
-  , AddDepRes (..)
-  , W (..)
-  , Ctx (..)
-  , M
-  , PackageInfo (..)
+  ( PackageInfo (..)
   , CombinedMap
+  , M
+  , W (..)
+  , AddDepRes (..)
   , toTask
   , adrVersion
   , adrHasLibrary
+  , Ctx (..)
+  , UnregisterState (..)
+  , ToolWarning (..)
   ) where
 
 import           Generics.Deriving.Monoid ( mappenddefault, memptydefault )

diff --git a/src/Stack/Types/ComponentUtils.hs b/src/Stack/Types/ComponentUtils.hs
@@ -8,9 +8,8 @@
 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
 {-# LANGUAGE ScopedTypeVariables        #-}
 
--- | A module providing the types that represent different sorts of components
--- of a package (library and sub-library, foreign library, executable, test
--- suite and benchmark).
+-- | A module providing a type representing the name of an \'unqualified\'
+-- component and related helper functions.
 module Stack.Types.ComponentUtils
   ( StackUnqualCompName (..)
   , fromCabalName