io-sim: fixed a link in haddocks to STM

input-output-hk · Oct 18, 2024 · 13fa0cf · 13fa0cf
1 parent f5d40d9
commit 13fa0cf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/io-sim/src/Control/Monad/IOSim/STM.hs b/io-sim/src/Control/Monad/IOSim/STM.hs
@@ -234,7 +234,7 @@ unGetTBQueueDefault (TBQueue queue _size) a = do
 --
 -- /Implementation details:/
 --
--- 'STM' does not guarantee fairness, instead it provide compositionally.
+-- @STM@ does not guarantee fairness, instead it provides compositionally.
 -- Fairness of 'putMVarDefault' and 'takeMVarDefault' is provided by tracking
 -- queue of blocked operation in the 'MVarState', e.g.  when a 'putMVarDefault'
 -- is scheduled on a full 'MVar', the request is put on to the back of the queue

diff --git a/io-sim/src/Control/Monad/IOSim/Types.hs b/io-sim/src/Control/Monad/IOSim/Types.hs
@@ -236,8 +236,8 @@ data StmA s a where
   LiftSTStm    :: StrictST.ST s a -> (a -> StmA s b) -> StmA s b
   FixStm       :: (x -> STM s x) -> (x -> StmA s r) -> StmA s r
 
--- | `IOSim`'s 'MonadSTM.STM' monad, as 'IOSim' it is parametrised by @s@, e.g.
--- @STMSim s a@ is monadic expression of type @a@.
+-- | `IOSim`'s 'Control.Monad.Class.MonadSTM.Internal.STM' monad, as 'IOSim' it
+-- is parametrised by @s@, e.g. @STMSim s a@ is monadic expression of type @a@.
 --
 type STMSim = STM