Skip to content

Commit 707dcb5

Browse files
committed
Add missing Haddock documentation.
1 parent e50fa0f commit 707dcb5

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

src/Stack/Build/ExecuteEnv.hs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ import System.Environment ( lookupEnv )
115115
import System.FileLock
116116
( SharedExclusive (..), withFileLock, withTryFileLock )
117117

118+
-- | Type representing environments in which the @Setup.hs@ commands of Cabal
119+
-- (the library) can be executed.
118120
data ExecuteEnv = ExecuteEnv
119121
{ installLock :: !(MVar ())
120122
, buildOpts :: !BuildOpts

src/Stack/Nix.hs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ instance Exception NixException where
4949
"Error: [S-7384]\n"
5050
++ "Cannot determine project root directory."
5151

52+
-- | Execute @nix-shell@, replacing the current process.
5253
runShellAndExit :: RIO Config void
5354
runShellAndExit = do
5455
inContainer <- getInContainer -- TODO we can probably assert that this is False based on Stack.Runners now
@@ -162,9 +163,10 @@ escape str =
162163
++ foldr (\c -> if c == '\'' then ("'\"'\"'"++) else (c:)) "" str
163164
++ "'"
164165

165-
-- | Command-line argument for "nix"
166+
-- | Command-line argument for "nix".
166167
nixCmdName :: String
167168
nixCmdName = "nix"
168169

170+
-- | Command-line option to show only @--nix-*@ options.
169171
nixHelpOptName :: String
170172
nixHelpOptName = nixCmdName ++ "-help"

src/Stack/Options/NixParser.hs

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

44
{-|
55
Module : Stack.Options.NixParser
6+
Description : Parser for options for Nix integration.
67
License : BSD-3-Clause
8+
9+
Parser for Stack's command line options for Nix integration.
710
-}
811

912
module Stack.Options.NixParser
@@ -23,6 +26,7 @@ import Stack.Options.Utils ( hideMods )
2326
import Stack.Prelude
2427
import Stack.Types.Nix ( NixOptsMonoid (..) )
2528

29+
-- | Parser for Stack's command line options for integration with Nix.
2630
nixOptsParser :: Bool -> Parser NixOptsMonoid
2731
nixOptsParser hide0 = overrideActivation <$>
2832
( NixOptsMonoid

0 commit comments

Comments
 (0)