From 2d89f3f14f1f5c89a48629b90e005006b96b3285 Mon Sep 17 00:00:00 2001 From: Mike Pilgrem Date: Mon, 9 Oct 2023 20:22:06 +0100 Subject: [PATCH] Updates to Haddock documentation. --- src/Stack/SDist.hs | 4 ++-- src/Stack/SourceMap.hs | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Stack/SDist.hs b/src/Stack/SDist.hs index 8aa1892216..dc277257dc 100644 --- a/src/Stack/SDist.hs +++ b/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 diff --git a/src/Stack/SourceMap.hs b/src/Stack/SourceMap.hs index 605a015f15..d021e612c6 100644 --- a/src/Stack/SourceMap.hs +++ b/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