Reorgaize docs, move config to Channel/Type

src/Streamly/Internal/Data/Stream/Channel.hs

@@ -8,49 +8,23 @@
 
 module Streamly.Internal.Data.Stream.Channel
     (
-    -- ** Primitives
       module Streamly.Internal.Data.Stream.Channel.Type
-    , module Streamly.Internal.Data.Stream.Channel.Dispatcher
-    , module Streamly.Internal.Data.Stream.Channel.Consumer
 
-    -- ** Allocating and Using
+    -- ** Allocation
     , newChannel
     , module Streamly.Internal.Data.Stream.Channel.Append
     , module Streamly.Internal.Data.Stream.Channel.Interleave
+
+    , module Streamly.Internal.Data.Stream.Channel.Dispatcher
+    , module Streamly.Internal.Data.Stream.Channel.Consumer
+
+    -- ** Conversion
+    , module Streamly.Internal.Data.Stream.Channel.Operations
+
+    -- ** Evaluation
     , withChannel
     , withChannelK
     -- quiesceChannel -- wait for running tasks but do not schedule any more.
-    -- ** Conversions
-    , module Streamly.Internal.Data.Stream.Channel.Operations
-
-    -- ** Configuration
-    , Config
-    , defaultConfig
-
-    -- *** Limits
-    , maxThreads
-    , maxBuffer
-
-    -- *** Rate Control
-    , Rate(..)
-    , rate
-    , avgRate
-    , minRate
-    , maxRate
-    , constRate
-
-    -- *** Stop behavior
-    , StopWhen (..)
-    , stopWhen
-    , getStopWhen
-
-    -- *** Scheduling behavior
-    , eager
-    , ordered
-    , interleaved
-
-    -- *** Diagnostics
-    , inspect
     )
 where
 

src/Streamly/Internal/Data/Stream/Channel/Consumer.hs

@@ -8,11 +8,9 @@
 --
 module Streamly.Internal.Data.Stream.Channel.Consumer
     (
-    -- * Read Output
+    -- ** Reading
       readOutputQPaced
     , readOutputQBounded
-
-    -- * Postprocess Hook After Reading
     , postProcessPaced
     , postProcessBounded
     )

src/Streamly/Internal/Data/Stream/Channel/Dispatcher.hs

@@ -9,7 +9,7 @@
 --
 module Streamly.Internal.Data.Stream.Channel.Dispatcher
     (
-    -- * Dispatching
+    -- ** Dispatching
       pushWorker
     , dispatchWorker
     , dispatchWorkerPaced

src/Streamly/Internal/Data/Stream/Channel/Operations.hs

@@ -44,7 +44,7 @@ import qualified Streamly.Internal.Data.StreamK as K
 
 import Streamly.Internal.Data.Channel.Types hiding (inspect)
 import Streamly.Internal.Data.Stream.Channel.Dispatcher
-import Streamly.Internal.Data.Stream.Channel.Type
+import Streamly.Internal.Data.Stream.Channel.Type hiding (inspect)
 
 import Prelude hiding (map, concat, concatMap)
 

src/Streamly/Internal/Data/Stream/Channel/Type.hs

@@ -8,7 +8,37 @@
 
 module Streamly.Internal.Data.Stream.Channel.Type
     (
+    -- ** Type
       Channel(..)
+
+    -- ** Configuration
+    , Config
+
+    -- *** Limits
+    , maxThreads
+    , maxBuffer
+
+    -- *** Rate Control
+    , Rate(..)
+    , rate
+    , avgRate
+    , minRate
+    , maxRate
+    , constRate
+
+    -- *** Stop behavior
+    , StopWhen (..)
+    , stopWhen
+
+    -- *** Scheduling behavior
+    , eager
+    , ordered
+    , interleaved
+
+    -- *** Diagnostics
+    , inspect
+
+    -- ** Primitives
     , yieldWith
     , stopWith
     , exceptionWith