Skip to content

fix phantom type var in doc strings #9

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
Mar 14, 2017
Merged

fix phantom type var in doc strings #9

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
6 changes: 3 additions & 3 deletions src/Control/Monad/ST.purs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import Control.Monad.Eff (Eff, runPure)
-- | The `runST` function can be used to handle the `ST` effect.
foreign import data ST :: * -> !

-- | The type `STRef s a` represents a mutable reference holding a value of
-- | type `a`, which can be used with the `ST s` effect.
-- | The type `STRef h a` represents a mutable reference holding a value of
-- | type `a`, which can be used with the `ST h` effect.
foreign import data STRef :: * -> * -> *

-- | Create a new mutable reference.
Expand Down Expand Up @@ -44,7 +44,7 @@ foreign import writeSTRef
-- | Run an `ST` computation.
-- |
-- | Note: the type of `runST` uses a rank-2 type to constrain the phantom
-- | type `s`, such that the computation must not leak any mutable references
-- | type `h`, such that the computation must not leak any mutable references
-- | to the surrounding computation.
-- |
-- | It may cause problems to apply this function using the `$` operator. The
Expand Down