Updates to Haddock documentation.

Author: mpilgrem

src/Stack/SDist.hs

@@ -456,8 +456,8 @@ readLocalPackage pkgDir = do
     , lpWanted = False -- HACK: makes it so that sdist output goes to a log
                        -- instead of a file.
     , lpCabalFile = cabalfp
-    -- NOTE: these aren't the 'correct values, but aren't used in
-    -- the usage of this function in this module.
+    -- NOTE: these aren't the 'correct' values, but aren't used in the usage of
+    -- this function in this module.
     , lpTestBench = Nothing
     , lpBuildHaddocks = False
     , lpForceDirty = False

src/Stack/SourceMap.hs

@@ -80,6 +80,7 @@ mkProjectPackage printWarnings dir buildHaddocks = do
 additionalDepPackage ::
      forall env. (HasPantryConfig env, HasLogFunc env, HasProcessContext env)
   => Bool
+     -- ^ Should Haddock documentation be built for the package?
   -> PackageLocation
   -> RIO env DepPackage
 additionalDepPackage buildHaddocks pl = do
@@ -111,6 +112,7 @@ additionalDepPackage buildHaddocks pl = do
 snapToDepPackage ::
      forall env. (HasPantryConfig env, HasLogFunc env, HasProcessContext env)
   => Bool
+     -- ^ Should Haddock documentation be built for the package?
   -> PackageName
   -> SnapshotPackage
   -> RIO env DepPackage
@@ -281,6 +283,7 @@ loadProjectSnapshotCandidate ::
   => RawSnapshotLocation
   -> PrintWarnings
   -> Bool
+     -- ^ Should Haddock documentation be build for the package?
   -> RIO env (SnapshotCandidate env)
 loadProjectSnapshotCandidate loc printWarnings buildHaddocks = do
   debugRSL <- view rslInLogL