Skip to content

Commit

Permalink
Haddock tidying
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelpj committed May 1, 2024
1 parent d415ad2 commit 70d6fe1
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions bluefin-internal/src/Bluefin/Internal.hs
Original file line number Diff line number Diff line change
Expand Up @@ -396,18 +396,18 @@ exception. This is essentially the same as
@Control.Exception.'Control.Exception.bracket'@, whose
documentation you can inspect for further details.
@bracket@ has a very general type that does not require @es@ to contain
'bracket' has a very general type that does not require @es@ to contain
an exception or IO effect. The reason that this is safe is:
* While @bracket@ does catch exceptions, this is unobservable, since
* While 'bracket' does catch exceptions, this is unobservable, since
the exception is re-thrown; the cleanup action happens unconditionally;
and no part of it gets access to the thrown exception.
* @Eff@ itself is able to guarantee that any exceptions thrown in the body
will be actually thrown before @bracket@ exits. This is inherited
from the fact that @Eff@ is a wrapper around @IO@.
* 'Eff' itself is able to guarantee that any exceptions thrown in the body
will be actually thrown before 'bracket' exits. This is inherited
from the fact that 'Eff' is a wrapper around 'IO'.
While it is usually the case that the cleanup action will in fact want to
use @IO@ effects, this is not universally true, see the @polymorphicBracket@
use 'IO' effects, this is not universally true, see the @polymorphicBracket@
example for an example.
-}
bracket ::
Expand Down

0 comments on commit 70d6fe1

Please sign in to comment.