on master help sign in
Fix module references in docs
commitabd8bef4c7cb60d3fe60929fae25c6dfb267c31d authorHarendra Kumar <harendra.kumar@gmail.com> dateFri 1 Dec 2017, 00:49 (9 years ago) parent9510577
2 files changed+14−15
src/Streamly.hs+2−1 src/Streamly/Tutorial.hs+12−14
src/Streamly.hs+2−1
@@ -151,7 +151,8 @@ import Control.Monad.Trans.Class (MonadTrans (..))
151151-- concurrent composition operators '<|' and '<|>' require the underlying monad
152152-- of the streaming monad transformer to be 'MonadAsync'.
153153--
154−-- For more details please see the 'Streamly.Tutorial' and 'Streamly.Examples'.
154+-- For more details please see the "Streamly.Tutorial" and "Streamly.Examples"
155+-- (the latter is available only when built with the 'examples' build flag).
155156
156157-- A simple inline example here illustrating applicative, monad and alternative
157158-- compositions.
src/Streamly/Tutorial.hs+12−14
@@ -17,7 +17,7 @@
1717-- demand by the consumer. However, combinators are provided to fine tune the
1818-- concurrency control.
1919-- Streaming and concurrency together enable expressing reactive applications
20−-- conveniently. See 'Streamly.Examples' for a simple SDL based FRP example.
20+-- conveniently. See "Streamly.Examples" for a simple SDL based FRP example.
2121--
2222-- Streamly streams are very much like the Haskell lists and most of the
2323-- functions that work on lists have a counterpart that works on streams.
@@ -25,9 +25,9 @@
2525-- concurrently. In this tutorial we will go over the basic concepts and how to
2626-- use the library. The documentation of @Streamly@ module has more details on
2727-- core APIs. For more APIs for constructing, folding, filtering, mapping and
28−-- zipping etc. see the documentation of @Streamly.Prelude@ module. For
28+-- zipping etc. see the documentation of "Streamly.Prelude" module. For
2929-- examples and other ways to use the library see the module
30−-- @Streamly.Examples@ as well.
30+-- "Streamly.Examples" as well.
3131
3232module Streamly.Tutorial
3333 (
@@ -125,7 +125,6 @@ where
125125
126126import Streamly
127127import Streamly.Prelude
128−-- import Streamly.Examples
129128import Data.Semigroup
130129import Control.Applicative
131130import Control.Monad
@@ -161,7 +160,7 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
161160-- @
162161--
163162-- For more ways to construct or generate a stream see the module
164−-- @Streamly.Prelude@.
163+-- "Streamly.Prelude".
165164
166165-- $eliminating
167166--
@@ -191,7 +190,7 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
191190-- @
192191--
193192-- For other ways to eliminate or fold a stream see the module
194−-- @Streamly.Prelude@.
193+-- "Streamly.Prelude".
195194
196195-- $semigroup
197196-- Streams of the same type can be combined into a composite stream in many
@@ -349,7 +348,7 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
349348-- time. Take an example of a merge sort of two sorted streams. We need to
350349-- keep consuming items from the stream which has the lowest item in the sort
351350-- order. This can be achieved using async references to streams. See
352−-- 'Streamly.Examples.MergeSortedStreams'.
351+-- "Streamly.Examples.MergeSortedStreams".
353352
354353-- $monoid
355354--
@@ -364,7 +363,7 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
364363-- * 'foldMapWith' folds like foldWith but also maps a function before folding.
365364-- * 'forEachWith' is like foldMapwith but the container argument comes before
366365-- the function argument.
367−-- * The 'each' primitive from @Streamly.Prelude@ folds a 'Foldable' container
366+-- * The 'each' primitive from "Streamly.Prelude" folds a 'Foldable' container
368367-- using the '<>' operator:
369368--
370369-- All of the following are equivalent:
@@ -600,7 +599,7 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
600599-- @
601600--
602601-- Also see the 'mapM' and 'sequence' functions for mapping actions, in the
603−-- @Streamly.Prelude@ module.
602+-- "Streamly.Prelude" module.
604603
605604-- $applicative
606605--
@@ -703,11 +702,10 @@ import Control.Monad.Trans.Class (MonadTrans (lift))
703702-- $zipping
704703--
705704-- Zipping is a special transformation where the corresponding elements of two
706−-- streams are combined together using a zip function producing a new
707−-- stream of outputs. Two different types are provided for serial and
708−-- concurrent zipping. These types provide an applicative instance that zips
709−-- the argument streams. Also see the zipping function in the @Streamly.Prelude@
710−-- module.
705+-- streams are combined together using a zip function producing a new stream of
706+-- outputs. Two different types are provided for serial and concurrent zipping.
707+-- These types provide an applicative instance that zips the argument streams.
708+-- Also see the zipping function in the "Streamly.Prelude" module.
711709
712710-- $serialzip
713711--