summaryrefslogtreecommitdiff
path: root/src/Propellor/Message.hs
diff options
context:
space:
mode:
authorJoey Hess2016-06-13 23:18:57 -0400
committerJoey Hess2016-06-13 23:18:57 -0400
commit76ef2304395bf4402523098a785e1886091111cd (patch)
tree622ac3e5f1fadc4704b96fcef056462b59293354 /src/Propellor/Message.hs
parent23b44730801a2891e4a781c26508d63d3f7026db (diff)
wording
Diffstat (limited to 'src/Propellor/Message.hs')
-rw-r--r--src/Propellor/Message.hs8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/Propellor/Message.hs b/src/Propellor/Message.hs
index b7e96ec2..f728e143 100644
--- a/src/Propellor/Message.hs
+++ b/src/Propellor/Message.hs
@@ -109,9 +109,8 @@ infoMessage ls = liftIO $ outputConcurrent $ concatMap (++ "\n") ls
-- | Displays the error message in red, and throws an exception.
--
--- When used inside a property, the exception will only stop the current
--- property from being ensured. Propellor will continue ensuring other
--- properties.
+-- When used inside a property, the exception will make the current
+-- property fail. Propellor will continue to the next property.
errorMessage :: MonadIO m => String -> m a
errorMessage s = liftIO $ do
outputConcurrent =<< colorLine Vivid Red ("** error: " ++ s)
@@ -120,7 +119,8 @@ errorMessage s = liftIO $ do
-- caught, and so we say, cannot continue.
error "Cannot continue!"
--- | Like `errorMessage`, but throws a `StopPropellorException`
+-- | Like `errorMessage`, but throws a `StopPropellorException`,
+-- preventing propellor from continuing to the next property.
--
-- Think twice before using this. Is the problem so bad that propellor
-- cannot try to ensure other properties? If not, use `errorMessage`