Fix some inconsistencies in class docs

This commit is contained in:
Michael Walker 2015-08-14 15:26:43 +01:00
parent 4a76ecedcc
commit faa0febdba
2 changed files with 11 additions and 10 deletions

View File

@ -205,8 +205,6 @@ class ( Applicative m, Monad m
-- | Runs its argument, just as if the @_concNoTest@ weren't there. -- | Runs its argument, just as if the @_concNoTest@ weren't there.
-- --
-- > _concNoTest x = x
--
-- This function is purely for testing purposes, and indicates that -- This function is purely for testing purposes, and indicates that
-- it's not worth considering more than one schedule here. This is -- it's not worth considering more than one schedule here. This is
-- useful if you have some larger computation built up out of -- useful if you have some larger computation built up out of
@ -221,13 +219,13 @@ class ( Applicative m, Monad m
-- scope. As a rule-of-thumb: if you can't define it as a top-level -- scope. As a rule-of-thumb: if you can't define it as a top-level
-- function taking no @CVar@ arguments, you probably shouldn't -- function taking no @CVar@ arguments, you probably shouldn't
-- @_concNoTest@ it. -- @_concNoTest@ it.
--
-- > _concNoTest x = x
_concNoTest :: m a -> m a _concNoTest :: m a -> m a
_concNoTest = id _concNoTest = id
-- | Does nothing. -- | Does nothing.
-- --
-- > _concKnowsAbout _ = return ()
--
-- This function is purely for testing purposes, and indicates that -- This function is purely for testing purposes, and indicates that
-- the thread has a reference to the provided @CVar@ or -- the thread has a reference to the provided @CVar@ or
-- @CTVar@. This function may be called multiple times, to add new -- @CTVar@. This function may be called multiple times, to add new
@ -238,13 +236,13 @@ class ( Applicative m, Monad m
-- Gathering this information allows detection of cases where the -- Gathering this information allows detection of cases where the
-- main thread is blocked on a variable no runnable thread has a -- main thread is blocked on a variable no runnable thread has a
-- reference to, which is a deadlock situation. -- reference to, which is a deadlock situation.
--
-- > _concKnowsAbout _ = return ()
_concKnowsAbout :: Either (CVar m a) (CTVar (STMLike m) a) -> m () _concKnowsAbout :: Either (CVar m a) (CTVar (STMLike m) a) -> m ()
_concKnowsAbout _ = return () _concKnowsAbout _ = return ()
-- | Does nothing. -- | Does nothing.
-- --
-- > _concForgets _ = return ()
--
-- The counterpart to '_concKnowsAbout'. Indicates that the -- The counterpart to '_concKnowsAbout'. Indicates that the
-- referenced variable will never be touched again by the current -- referenced variable will never be touched again by the current
-- thread. -- thread.
@ -252,12 +250,13 @@ class ( Applicative m, Monad m
-- Note that inappropriate use of @_concForgets@ can result in false -- Note that inappropriate use of @_concForgets@ can result in false
-- positives! Be very sure that the current thread will /never/ -- positives! Be very sure that the current thread will /never/
-- refer to the variable again, for instance when leaving its scope. -- refer to the variable again, for instance when leaving its scope.
--
-- > _concForgets _ = return ()
_concForgets :: Either (CVar m a) (CTVar (STMLike m) a) -> m () _concForgets :: Either (CVar m a) (CTVar (STMLike m) a) -> m ()
_concForgets _ = return ()
-- | Does nothing. -- | Does nothing.
-- --
-- > _concAllKnown = return ()
--
-- Indicates to the test runner that all variables which have been -- Indicates to the test runner that all variables which have been
-- passed in to this thread have been recorded by calls to -- passed in to this thread have been recorded by calls to
-- '_concKnowsAbout'. If every thread has called '_concAllKnown', -- '_concKnowsAbout'. If every thread has called '_concAllKnown',
@ -267,6 +266,8 @@ class ( Applicative m, Monad m
-- future (for instance, if one was sent over a channel), then -- future (for instance, if one was sent over a channel), then
-- '_concKnowsAbout' should be called immediately, otherwise there -- '_concKnowsAbout' should be called immediately, otherwise there
-- is a risk of identifying false positives. -- is a risk of identifying false positives.
--
-- > _concAllKnown = return ()
_concAllKnown :: m () _concAllKnown :: m ()
_concAllKnown = return () _concAllKnown = return ()

View File

@ -67,13 +67,13 @@ class (Applicative m, Monad m, MonadCatch m, MonadThrow m) => MonadSTM m where
-- | Throw an exception. This aborts the transaction and propagates -- | Throw an exception. This aborts the transaction and propagates
-- the exception. -- the exception.
-- --
-- > throwSTM = throwM -- > throwSTM = Control.Monad.Catch.throwM
throwSTM :: Exception e => e -> m a throwSTM :: Exception e => e -> m a
throwSTM = throwM throwSTM = throwM
-- | Handling exceptions from 'throwSTM'. -- | Handling exceptions from 'throwSTM'.
-- --
-- > catchSTM = catch -- > catchSTM = Control.Monad.Catch.catch
catchSTM :: Exception e => m a -> (e -> m a) -> m a catchSTM :: Exception e => m a -> (e -> m a) -> m a
catchSTM = Control.Monad.Catch.catch catchSTM = Control.Monad.Catch.catch