Skip to content

io-sim: fixed a link in haddocks to STM #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 18, 2024
+3 −3
Merged

io-sim: fixed a link in haddocks to STM #190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion io-sim/src/Control/Monad/IOSim/STM.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions io-sim/src/Control/Monad/IOSim/Types.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading