Skip to content

Commit 1988474

Browse files
committed
Add missing Haddock documentation
1 parent 77fe11b commit 1988474

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

src/Stack/Eval.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import Stack.Exec
2323
import Stack.Prelude
2424
import Stack.Types.Runner ( Runner )
2525

26-
-- Type representing command line options for the @stack eval@ command.
26+
-- | Type representing command line options for the @stack eval@ command.
2727
data EvalOpts = EvalOpts
2828
{ arg :: !String
2929
, extra :: !ExecOptsExtra

src/Stack/Exec.hs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,14 +102,19 @@ instance Pretty ExecPrettyException where
102102

103103
instance Exception ExecPrettyException
104104

105-
-- Type representing Stack's execution commands.
105+
-- | Type representing Stack's execution commands.
106106
data SpecialExecCmd
107107
= ExecCmd String
108+
-- ^ @stack exec@ command.
108109
| ExecRun
110+
-- ^ @stack run@ command.
109111
| ExecGhc
112+
-- ^ @stack ghc@ command.
110113
| ExecRunGhc
114+
-- ^ @stack runghc@ or @stack runhaskell@ command.
111115
deriving (Eq, Show)
112116

117+
-- | Type representing extra Stack options for Stack's execution commands.
113118
data ExecOptsExtra = ExecOptsExtra
114119
{ envSettings :: !EnvSettings
115120
, packages :: ![String]
@@ -118,15 +123,15 @@ data ExecOptsExtra = ExecOptsExtra
118123
}
119124
deriving Show
120125

121-
-- Type representing options for Stack's execution commands.
126+
-- | Type representing options for Stack's execution commands.
122127
data ExecOpts = ExecOpts
123128
{ cmd :: !SpecialExecCmd
124129
, args :: ![String]
125130
, extra :: !ExecOptsExtra
126131
}
127132
deriving Show
128133

129-
-- Type representing valid targets for --package option.
134+
-- | Type representing valid targets for @--package@ option.
130135
data ExecTarget = ExecTarget PackageName (Maybe Version)
131136

132137
-- | The function underlying Stack's @exec@, @ghc@, @run@, @runghc@ and

0 commit comments

Comments
 (0)