Add docstring to `check`
authorHerbert Valerio Riedel <hvr@gnu.org>
Sat, 3 Feb 2018 20:44:15 +0000 (21:44 +0100)
committerHerbert Valerio Riedel <hvr@gnu.org>
Sat, 3 Feb 2018 20:44:15 +0000 (21:44 +0100)
Control/Monad/STM.hs

index d673625..4887568 100644 (file)
@@ -78,6 +78,11 @@ instance Alternative STM where
   (<|>) = orElse
 #endif
 
+-- | Check that the boolean condition is true and, if not, 'retry'.
+--
+-- In other words, @check b = unless b retry@.
+--
+-- @since 2.1.1
 check :: Bool -> STM ()
 check b = if b then return () else retry
 #endif