Skip to content

Commit 37663ff

Browse files
committed
fix phantom type var in doc strings
The code always refers to the ST phantom type as `h`. The docs refered to it as `s`. This was confusing.
1 parent 85abcb6 commit 37663ff

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/Control/Monad/ST.purs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ import Control.Monad.Eff (Eff, runPure)
1111
-- | The `runST` function can be used to handle the `ST` effect.
1212
foreign import data ST :: * -> !
1313

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

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

0 commit comments

Comments
 (0)