on master help sign in
Fix prelude documentation
commitad58b1fab76742b25a155fb595d733023276f8f8 authorHarendra Kumar <harendra@composewell.com> dateWed 7 Dec 2022, 17:28 (4 years ago) parent2928602
4 files changed+22−25
src/Streamly/Data/Stream/Concurrent.hs+15−14 src/Streamly/Data/Stream/Exception.hs+1 src/Streamly/Data/Stream/Prelude.hs+1−7 src/Streamly/Data/Stream/Time.hs+5−4
src/Streamly/Data/Stream/Concurrent.hs+15−14
@@ -90,16 +90,17 @@
9090
9191module Streamly.Data.Stream.Concurrent
9292 (
93+ -- * Concurrency
9394 MonadAsync
9495
95− -- * Configuration
96+ -- ** Configuration
9697 , Config
9798
98− -- ** Limits
99+ -- *** Limits
99100 , maxThreads
100101 , maxBuffer
101102
102− -- ** Rate Control
103+ -- *** Rate Control
103104 , Rate(..)
104105 , rate
105106 , avgRate
@@ -107,33 +108,33 @@ module Streamly.Data.Stream.Concurrent
107108 , maxRate
108109 , constRate
109110
110− -- ** Stop behavior
111+ -- *** Stop behavior
111112 , StopWhen (..)
112113 , stopWhen
113114
114− -- ** Scheduling behavior
115+ -- *** Scheduling behavior
115116 , eager
116117 , ordered
117118 , interleaved
118119
119− -- ** Diagnostics
120+ -- *** Diagnostics
120121 , inspect
121122
122− -- * Combinators
123+ -- ** Combinators
123124 -- | Stream combinators using a concurrent channel.
124125
125− -- ** Evaluate
126+ -- *** Evaluate
126127 -- | Evaluates a stream concurrently using a channel.
127128
128129 -- , eval
129130 , parEval
130131
131− -- ** Generate
132+ -- *** Generate
132133 -- | Uses a single channel to evaluate mapped actions concurrently.
133134 , parRepeatM
134135 , parReplicateM
135136
136− -- ** Map
137+ -- *** Map
137138 -- | Uses a single channel to evaluate mapped actions concurrently.
138139
139140 -- , mapM
@@ -141,7 +142,7 @@ module Streamly.Data.Stream.Concurrent
141142 -- , sequence
142143 , parSequence
143144
144− -- ** List of streams
145+ -- *** List of streams
145146 -- | Shares a single channel across many streams.
146147
147148 -- , append
@@ -153,13 +154,13 @@ module Streamly.Data.Stream.Concurrent
153154 -- , zipWithM
154155 -- , zipWith
155156
156− -- ** Stream of streams
157− -- *** Apply
157+ -- *** Stream of streams
158+ -- **** Apply
158159
159160 -- , apply
160161 , parApply
161162
162− -- *** Concat
163+ -- **** Concat
163164 -- | Shares a single channel across many streams.
164165
165166 -- , concat
src/Streamly/Data/Stream/Exception.hs+1
@@ -13,6 +13,7 @@
1313--
1414module Streamly.Data.Stream.Exception
1515 (
16+ -- * Lifted Exceptions
1617 after
1718 , bracket
1819 -- , bracket3
src/Streamly/Data/Stream/Prelude.hs+1−7
@@ -13,12 +13,8 @@
1313module Streamly.Data.Stream.Prelude
1414 ( module Streamly.Data.Stream
1515 , module Streamly.Data.Stream.Concurrent
16− , module Streamly.Data.Stream.Exception
1716 , module Streamly.Data.Stream.Time
18− , liftInner
19− , runReaderT
20− , runStateT
21− -- , module Streamly.Internal.Data.Stream.Extra
17+ , module Streamly.Data.Stream.Exception
2218 )
2319where
2420
@@ -26,5 +22,3 @@ import Streamly.Data.Stream
2622import Streamly.Data.Stream.Concurrent
2723import Streamly.Data.Stream.Exception
2824import Streamly.Data.Stream.Time
29−import Streamly.Internal.Data.Stream.Transformer
30−import Streamly.Internal.Data.Stream.Extra
src/Streamly/Data/Stream/Time.hs+5−4
@@ -15,17 +15,18 @@
1515--
1616module Streamly.Data.Stream.Time
1717 (
18− -- * Timers
18+ -- * Time
19+ -- ** Timers
1920 interject
2021
21− -- * Trimming
22+ -- ** Trimming
2223 , takeInterval
2324 , dropInterval
2425
25− -- * Chunking
26+ -- ** Chunking
2627 , intervalsOf
2728
28− -- * Sampling
29+ -- ** Sampling
2930 , sampleIntervalEnd
3031 , sampleIntervalStart
3132 , sampleBurstEnd