Skip to content

Commit 77fe11b

Browse files
committed
Add missing Haddock documentation.
1 parent 73095ab commit 77fe11b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/Stack/Ls.hs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,24 +122,30 @@ data SnapshotType
122122
-- ^ Stackage Nightly
123123
deriving (Eq, Ord, Show)
124124

125+
-- | Type representing command line options for the @stack ls globals@ command.
125126
newtype ListGlobalsOpts = ListGlobalsOpts
126127
{ globalHints :: Bool
127128
-- ^ Use global hints instead of relying on an actual GHC installation.
128129
}
129130

131+
-- | Type representing command line options for the @stack ls dependencies@
132+
-- command.
130133
data ListDepsOpts = ListDepsOpts
131134
{ format :: !ListDepsFormat
132135
-- ^ Format of printing dependencies
133136
, dotOpts :: !DotOpts
134137
-- ^ The normal dot options.
135138
}
136139

140+
-- | Type representing formats for printing dependencies.
137141
data ListDepsFormat
138142
= ListDepsText ListDepsFormatOpts [ListDepsTextFilter]
139143
| ListDepsTree ListDepsFormatOpts
140144
| ListDepsJSON
141145
| ListDepsConstraints
142146

147+
-- | Type representing command line options for the @stack ls dependencies text@
148+
-- command and similar @cabal@, @tree@ and @json@ commands.
143149
data ListDepsFormatOpts = ListDepsFormatOpts
144150
{ sep :: !Text
145151
-- ^ Separator between the package name and details.
@@ -301,6 +307,7 @@ handleRemote lsOpts = do
301307
where
302308
urlInfo = "https://www.stackage.org/snapshots"
303309

310+
-- | Function underlying the @stack ls@ command.
304311
lsCmd :: LsCmdOpts -> RIO Runner ()
305312
lsCmd lsOpts =
306313
case lsOpts.lsCmds of

0 commit comments

Comments
 (0)