Browse Source

Fixes error in documentation

Marcos Dumay de Medeiros 7 years ago
parent
commit
e5984bf2bb
1 changed files with 21 additions and 21 deletions
  1. 21 21
      interruptible.cabal

+ 21 - 21
interruptible.cabal

@@ -5,25 +5,27 @@ name:                interruptible
 version:             0.1.1.1
 synopsis:            Monad transformers that can be run and resumed later, conserving their context.
 description:
+    This package provides the functionality needed to intercalate the execution of different
+    transformers, and passing their state around as values for resuming later. Further
+    explanations for where to use it is available at the sealgram blog:
+    <https://sealgram.com/blog/interruptible-monad-transformers.html>. The following is about
+    how to use the package:
+    .
     Given an inner monad @M@ and a transformer @T@, if T is an interruptible transformer,
     it becomes possible to intercalate functions over its context with functions over the
     inner monad. That is, code like this:
     .
-    @
-    runT (f 1 >>= g)
-    where
-        f :: Int -> T M a
-        g :: a -> T M b
-    @
+    > runT (f 1 >>= g)
+    > where
+    >     f :: Int -> T M a
+    >     g :: a -> T M b
     .
     Can be broken up like this:
     .
-    @
-    do
-    let c0 = inTCtx 1
-    c1 <- resume f ct1
-    _ <- resume g ct2
-    @
+    > do
+    >     let c0 = inTCtx 1
+    >     c1 <- resume f c0
+    >     _ <- resume g c1
     .
     That makes it possible to intercalate the execution of different contexts, and
     treat contexts like data, for iterating or returning them.
@@ -37,15 +39,13 @@ description:
     composition of @resume@ calls, and their contexts must be created and peeled on the inverse
     order that they appear on the stack. Like:
     .
-    @
-    do
-    let c0 = inT2Ctx . inT1Ctx $ 1
-    c1 <- (resume . resume) f ct1
-    _ <- (resume . resume) g ct2
-    where
-        f :: Monad m => Int -> T1 T2 M a
-        g :: Monad m => a -> T1 T2 M b
-    @
+    > do
+    >     let c0 = inT2Ctx . inT1Ctx $ 1
+    >     c1 <- (resume . resume) f c0
+    >     _ <- (resume . resume) g c1
+    > where
+    >     f :: Monad m => Int -> T1 T2 M a
+    >     g :: Monad m => a -> T1 T2 M b
     .
     For convenience, the @Interruptible@ module exports the @resume2@ to @resume5@
     functions as composotions of resume. They can be composed further as in