Merge pull request #116 from abailly-iohk/abailly-iohk/document-monad-delay

Provide minimal haddock comments for MonadDelay

Author: bolt12

io-classes/CHANGELOG.md

@@ -9,6 +9,8 @@
   `io-sim`, since the underlying monad is `ST`. `IO` has no underlying monad, so
   the provided instance for `IO` defaults `inspectMVar` to `tryReadMVar`.
 
+* Add some Haddock documentation to `MonadDelay`
+
 ## 1.1.0.0
 
 ### Breaking changes

io-classes/src/Control/Monad/Class/MonadTimer.hs

@@ -4,6 +4,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies        #-}
 
+-- | Provides classes to handle delays and timeouts.
 module Control.Monad.Class.MonadTimer
   ( MonadDelay (..)
   , MonadTimer (..)
@@ -18,13 +19,22 @@ import           Control.Monad.Trans (lift)
 
 import qualified System.Timeout as IO
 
+-- | A typeclass to delay current thread.
 class Monad m => MonadDelay m where
+
+  -- | Suspends the current thread for a given number of microseconds
+  -- (GHC only).
+  --
+  -- See `IO.threadDelay`.
   threadDelay :: Int -> m ()
 
+-- | A typeclass providing utilities for /timeouts/.
 class (MonadDelay m, MonadSTM m) => MonadTimer m where
 
+  -- | See `STM.registerDelay`.
   registerDelay :: Int -> m (TVar m Bool)
 
+  -- | See `IO.timeout`.
   timeout :: Int -> m a -> m (Maybe a)
 
 --