Skip to content

Commit 652ec58

Browse files
committed
Add missing Haddock documentation
1 parent a4b3d3d commit 652ec58

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

src/Stack/Options/BuildMonoidParser.hs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
{-|
44
Module : Stack.Options.BuildMonoidParser
5+
Description : Parse arguments for Stack's build configuration.
56
License : BSD-3-Clause
7+
8+
Parse arguments for Stack's build configuration.
69
-}
710

811
module Stack.Options.BuildMonoidParser
912
( buildOptsMonoidParser
10-
, cabalVerboseParser
11-
, cabalVerbosityOptsParser
12-
, cabalVerbosityParser
1313
) where
1414

1515
import Distribution.Parsec ( eitherParsec )
@@ -33,6 +33,7 @@ import Stack.Types.BuildOptsMonoid
3333
)
3434
import Stack.Types.ComponentUtils ( unqualCompFromString )
3535

36+
-- | Parse command line arguments for build configuration.
3637
buildOptsMonoidParser :: GlobalOptsContext -> Parser BuildOptsMonoid
3738
buildOptsMonoidParser hide0 = BuildOptsMonoid
3839
<$> trace'

src/Stack/Options/Completion.hs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@
44

55
{-|
66
Module : Stack.Options.Completion
7+
Description : Completers for command line arguments.
78
License : BSD-3-Clause
9+
10+
Completers for command line arguments or arguments of command line options.
811
-}
912

1013
module Stack.Options.Completion
@@ -38,6 +41,7 @@ import Stack.Types.ProjectConfig ( ProjectConfig (..) )
3841
import Stack.Types.NamedComponent ( renderPkgComponent )
3942
import Stack.Types.SourceMap ( SMWanted (..), ppComponents, ppGPD )
4043

44+
-- | A completer for @--ghc-options@ or @--ghci-options@.
4145
ghcOptsCompleter :: Completer
4246
ghcOptsCompleter = mkCompleter $ \inputRaw -> pure $
4347
let input = unescapeBashArg inputRaw
@@ -67,6 +71,7 @@ buildConfigCompleter inner = mkCompleter $ \inputRaw -> do
6771
let go = go' { logLevel = LevelOther "silent" }
6872
withRunnerGlobal go $ withConfig NoReexec $ withDefaultEnvConfig $ inner input
6973

74+
-- | A completer for components of project packages.
7075
targetCompleter :: Completer
7176
targetCompleter = buildConfigCompleter $ \input -> do
7277
packages <- view $ buildConfigL . to (.smWanted.project)
@@ -79,6 +84,7 @@ targetCompleter = buildConfigCompleter $ \input -> do
7984
allComponentNames (name, comps) =
8085
map (T.unpack . renderPkgComponent . (name,)) (Set.toList comps)
8186

87+
-- | A completer for Cabal flags of project packages.
8288
flagCompleter :: Completer
8389
flagCompleter = buildConfigCompleter $ \input -> do
8490
bconfig <- view buildConfigL
@@ -111,6 +117,7 @@ flagCompleter = buildConfigCompleter $ \input -> do
111117
('*' : _) -> wildcardFlags
112118
_ -> normalFlags
113119

120+
-- | A completer for executable components of project packages.
114121
projectExeCompleter :: Completer
115122
projectExeCompleter = buildConfigCompleter $ \input -> do
116123
packages <- view $ buildConfigL . to (.smWanted.project)

0 commit comments

Comments
 (0)